Skip to content

To create an Integration, open the Integrations tab on your Vercel dashboard, click the Integrations Console button, and choose Create.

Create a new Integration from the Console.

In this section, you are asked to fill out the basic details of your Integration which include fields like Name, URL Slug, Descriptions, Logo, and Media content.

In addition to these fields, you need to configure four other important settings for the Integration.

This URL should point to your site to serve the UI during installation and call the Vercel API. See ways your Integration can be installed to learn which parameters are available during installation.

Note: For local development and testing, you can specify a URL on localhost.

When you create a new integration, you are asked to select multiple API Scopes that your integration needs. These scopes will help you access the Vercel API. These scopes can be configured for permissions like Read and Read/Write as per your requirements.

Select API Scopes for your Integration.

With your integration, you can listen for events on the Vercel Platform via Webhooks. See the Webhooks docs to learn more.

To allow the developer to configure an installed integration, you can specify a Configuration URL. This URL is used for the Configure Button on each Configuration page. Clicking this button will redirect the developer to your specified URL with a configurationId query parameter. See Interacting with Configurations to learn more.

Note: If you don't specify a Configuration URL, all developers will see a Website button instead of a Configure button at the top of the configuration page. The Website button links to the website URL you specified on integration settings.

Once you have created your Integration, you can see it listed on the Integrations Developer Console.

Inside your Integration, click the "View In Marketplace" button to preview the live URL for your integration in the Marketplace. This URL can be shared with anyone who wants to install and use your Integration.

This live URL has the following format:

https://vercel.com/integrations/:slug
Note: Your Integration will not be visible on the Integrations Marketplace until it's approved by Vercel. If you want learn more, visit the Integrations Reference.