Skip to content

Install an Integration

Lean how to install integrations with Vercel.

There are three different ways to install your integration, each of which are detailed below:

The most common way to install an integration is via Vercel’s Integrations Marketplace.

Go to your desired integration page and click the "Add Integration" button. This shows the scope selection modal, followed by the project selection modal.

Choosing the projects that the Integration will have access to.

Here you must do the following:

  • Select the scope to install an integration (e.g. Personal Account or Team)
  • Select the projects that will have access to the integration (e.g. All or Specific Projects)
  • Confirm Integration permissions

Your Integration can only be installed once per scope (Personal Account or Team). If you select a scope to which the Integration is already installed, you are directed to the "Integration Configuration" page.

Note: If further configurations are required, the user can navigate to the Configuration URL by clicking the Configure Button on this page.

If the Integration is not installed in the selected scope, you're directed to a popup page, as defined by the developer in the Redirect URL.

When you create a Deploy Button for projects that are based on a Git repository, Vercel allows you to specify required integrations.

If the developer has specified Integration ids on the deploy button, Vercel will show a list of required integrations during the flow. Each integration has an Install button that opens up a popup with the Redirect URL.

Note: There is no option for scope and project selection during the Deploy Button flow. The created configuration has access to the newly created project only.

You'll may be prompted to install an Integration externally, through the third-party's mobile app or website. In this case, the developer will use a URL similar to the following to start the installation process from your side:

example-redirect-url
https://vercel.com/integrations/<integration-name>/new

You will be asked to select a Vercel scope (Personal Account or Team) to install the Integration and then will be redirected to the defined Redirect URL.

When installing from the External flow, your Integration can only be installed once per scope (Personal Account or Team). If you select a scope to which the Integration is already installed, a new code is generated, and you'll be sent to the Redirect URL. No new Configuration is created.