Reference
3 min read

Integration Approval Checklist

The integration approval checklist is used ensure all necessary steps have been taken for a great integration experience.
Table of Contents

Use this checklist to ensure all necessary steps have been taken for a great integration experience to get listed on the Integration Marketplace. Make sure you read the after integration creation guide before you start.

Navigate to /integrations/:slug to view the listing for the integration.

  • Is the logo properly centered and cropped? Does it look good in both light and dark mode?

  • Is the first image high-quality and suitable to be used in a Open Graph (OG) image (that gets automatically generated)?

  • Check to see if any of the images are blurry or show info they shouldn't. Do they all look professional / well polished?

Examples:

  • Does the description section use markdown where appropriate. For example, [link](#)

  • If there is an Instructions section, is it additional and helpful information? Avoid a step-by-step guide on how to install it.

  • Do the instructions clearly mention all environment variables that get set and ideally, what they are used for? Use the comment property when creating environment variables.

  • Does additional documentation exist? If so, is the documentation URL set?

From clicking the install button, a wizard should pop up, guiding you through the setup process.

  • Does the UI offer to select and map Vercel projects with the third-party? Important: Note that the project selection before the popup exists for security reasons. It does not imply the projects on which the user wants to install the integration.

  • Does the UI intelligently pre-select the first Vercel project to streamline the installation process and minimize user interaction?

  • If a user limits the scope to a single project within Vercel, does the popup obey this / make sense? Is the project selection disabled?

  • Are long project names on the project selection handled correctly without breaking the UI?

  • Does the UI come with sensible defaults during installation?

  • Are advanced settings hidden behind a toggle? For example, for a database integration selecting the region, RAM & CPU should be preselected and hidden so the UI is not bloated by many settings

  • Does the UI use pagination when listing all available projects? Users may have more than the pagination limit of the projects API.

  • Is it impossible for users to exit the installation flow? Links such as the logo or footer should always open in a new tab to prevent users from navigating away from the redirect URL during installation.

  • Does the authentication flow, such as sign-up, login, or forgotten password, work without interrupting the installation process? Can the user complete the installation successfully?

Deploy Buttons

allow users to install an integration together with an example repository on GitHub. This is a great way to get started with an integration.

  • Does the integration crash if it's already present on the selected scope? The integration shouldn't treat the passed configurationId as a new installation since it was previously installed.

After we have installed an integration (through the Marketplace), you should be presented with the details of your installation.

  • Is there a Configuration URL for the integration? Users should be able to modify linked projects by selecting projects in a similar way as during installation.

  • Are the environment variables set correctly with the right target?

Last updated on February 21, 2024