Building Integrations with Vercel REST API

See the following API reference documentation for how to use Vercel REST API to create integrations:

• Creating a Project Environment Variable
• Forwarding Logs using Log Drains
• Create an Access Token
• Interacting with Teams
• Interacting with Configurations
• Interacting with Vercel Projects

To use Vercel REST API, you need to authenticate with an access token that contains the necessary scope. You can then provide the API token through the Authorization header.

When you create an integration, you define a redirect URL that can have query parameters attached.

One of these parameters is the code parameter. This short-lived parameter is valid for 30 minutes and can be exchanged once for a long-lived access token using the following API endpoint:

{`POST https://api.vercel.com/v2/oauth/access_token`}

Pass the following values to the request body in the form of application/x-www-form-urlencoded.

The response of your code exchange request includes a team_id property. If team_id is not null, you know that this integration was installed on a team.

If your integration is installed on a team, append the teamId query parameter to each API request. See Accessing Resources Owned by a Team for more details.

Each installation of your integration is stored and tracked as a configuration.

Sometimes it makes sense to fetch the configuration in order to get more insights about the current scope or the projects your integration has access to.

To see which endpoints are available, see the Configurations documentation for more details.

When integration configurations are disabled:

• Any API requests will fail with a 403 HTTP status code and a code of integration_configuration_disabled
• We continue to send project.created, project.removed and integration-configuration.removed webhooks, as these will allow the integration configuration to operate correctly when re-activated. All other webhook delivery will be paused
• Log drains will not receive any logs

Deployments made with Vercel are grouped into Projects. This means that each deployment is assigned a name and is grouped into a project with other deployments using that same name.

Using the Vercel REST API, you can modify Projects that the Integration has access to. Here are some examples:

When building a Vercel Integration, you may want to expose an API token or a configuration URL for deployments within a Project.

You can do so by Creating a Project Environment Variable using the API.

When creating integrations the following scopes can be updated within the Integration Console:

As the Vercel REST API evolves, you'll need to update your scopes based on your integration's endpoint usage.

Additions and upgrades always require a review and confirmation. To ensure this, every affected user and team owner will be informed through email to undergo this process. Please make sure you provide a meaningful, short, and descriptive note for your changes.

Scope removals and downgrades won't require user confirmation and will be applied immediately to confirmed scopes and pending requested scope changes.

User and Teams will always confirm all pending changes with one confirmation. That means that if you have requested new scopes multiple times over the past year, the users will see a summary of all pending changes with their respective provided note.

Once a user confirms these changes, scopes get directly applied to the installation. You will also get notified through the new integration-configuration.scope-change-confirmed event.

When using the Vercel REST API with Integrations, you might come across some errors which you can address immediately.

To avoid CORS issues, make sure you only interact with the Vercel REST API on the server side.

Since the token grants access to resources of the Team or Personal Account, you should never expose it on the client side.

For more information on using CORS with Vercel, see How can I enable CORS on Vercel?.

Ensure you are not missing the teamId query parameter. teamId is required if the integration installation is for a Team. Ensure the Scope of Your Access Token is properly set.