Review Guidelines for IntegrationsAn internal review is required for your integration to be listed on the Vercel Marketplace. Learn about the guidelines Vercel uses to accept your Integration.
An internal review is required for your integration to be listed on the Vercel Marketplace.
Once you’re ready, email email@example.com and include the following:
- A link to your integration
- Integration support contact information (include name, email address, slack handle, and phone number)
- Any additional information that is required to test the integration
Once approved, Vercel will publish your integration on the marketplace.
Here are the review guidelines so you can make sure your integration is ready to be listed on the marketplace.
The installation of the integration is a critical component of the developer experience that must cater to all types of developers. While deciding the installation flow you should consider the following:
- New user flow (required): Developers should be able to create an account on your service while installing the integration
- Existing user flow (required): With existing accounts, developers should sign in as they install the integration. Also, make sure the forgotten password flow doesn't break the installation flow.
- Strong defaults (required): The installation flow should have minimal steps and have set defaults whenever possible
- Advanced settings (optional): Provide developers with the ability to override or expand settings when installing the integration
For the installation flow, you should consider adding the following specs:
Explain the integration and how to use it. Also explain the defaults and how to override them.
Create a Deploy Button for projects based on a Git repository. Refer to these guidelines.
The design review specs include properties for Icon and Gallery Images.
The image displayed in a circle, that appears throughout the dashboard and marketing pages.
Like all assets, it will appear in both light and dark mode.
These are a collection of images displayed on the carousel at the top of your marketplace listing. We require at least 3 images, but you can add up to 5. The images and text must be of high quality.
These gallery images will appear in both light and dark mode. Avoid long text, as it may not be legible on smaller screens.
Also consider the 20% safe zone around the edges of the image by placing the most important content of your images within the bounds. This will ensure that no information is cut when cropped.
Before adding "Icons" and "Gallery images" you need to make sure that the images follow the following dimensions and aspect ratios.
High resolution bitmap image, non-transparent PNG, minimum 256px
High resolution bitmap image, non-transparent PNG. Minimum 3 images, up to 5 can be uploaded. You can upload 1 video link too
Defining the content specs helps you create the main cover page of your integration. On the marketplace listing, the cover page looks like this.
The following requirements are located in the integrations console.
Integration title which appears on dashboard/marketing pages also, accompanied by the Integration Icon.
Integration tagline on the Marketplace card, and the Integrations overview in the dashboard.
Name of the Integration Owner, generally a legal name.
Predefined category helping developers find an integration easily. E.g. Performance, Analytics, CMS, etc.
Link to the Developer's site.
Link to the Integration documentation.
Long description of the integration.
Additional steps to install or configure your integrations. Include environment variables and their purpose. Use markdown for links or code snippets.