Building Integrations with Vercel REST APILearn how to use the Vercel REST API to build your Integrations and work with Redirect URLs.
The Vercel REST API is a REST-styled API that empowers you to gauge the capabilities of the entire Vercel platform including the Integrations.
When building an integration with Vercel, you can request Vercel Access Tokens to authenticate and use the Vercel REST API. You must provide an API token through the Authorization header.
When installing an Integration, users get redirected to your defined Redirect URL. Since there are several ways of installing an integration, different query parameters are attached.
One of these is the code parameter. This code is valid for 30 minutes and can be only exchanged once for an (long lived) access token.
Since Integrations are always installed on a certain scope, it's essential to understand the scope of your Access Tokens as well.
Make sure you append the
teamId query parameter to each API request, if your integration is installed on a team. See Accessing Resources Owned by a Team for more details.
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.
In addition to these Vercel REST API helps your Integrations to interact with the following:
You can exchange the
code parameter for an Access Token using the following API endpoint:
Pass the following values to request body in the form of
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, visit our API Documentation about Configurations.
When integration configurations are disabled:
- Any API requests will fail with a
403HTTP status code and a
- We continue to send
integration-configuration.removedwebhooks, 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.
See the following API reference documentation for how to utilize it:
When creating integrations the following scopes can be updated within the Integration Console:
Interact with the installation of your integration
Interact with deployments
Verify deployments with Checks
Create and manage Edge Configs and their tokens
Access project details and settings
Create and manage integration-owned project environment variables
Create and manage all account project environment variables
Access team details
Get information about the current user
Create and manage log drains to forward logs
Manage and interact with domains and certificates
Interact with an installation of your integration.
Interact with deployments.
Verify deployments with Checks.
Create and manage Edge Configs and their tokens.
Access project details and settings.
Create and manage integration-owned project environment variables.
Create and manage all account project environment variables.
Access team details.
Create and manage log drains to forward logs.
Manage and interact with domains and certificates.
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 via 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 via the new
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.
See Knowing the Scope of Your Access Token for more details.