4 min read

Extend your Vercel Workflow

Learn how to pair Vercel's functionality with a third-party service to streamline observability, integrate with testing tools, connect to your CMS, and more.
Table of Contents

Using Vercel doesn't stop at the products and features that we provide. Through integrations, you can use third-party platforms or services to extend the capabilities of Vercel and connect with third-party platforms or services to do things like sending logs to services, integrate with testing tools, connect to your CMS, and more.

You can extend the Vercel platform in any of the following ways:

  • Marketplace - The Integrations Marketplace is the best way to find suitable Integrations that fit into a variety of workflows including monitoring, databases, CMS, DevTools, and more.
  • Using templates - You can use one of our verified and pre-built templates to learn more about integrating your favorite tools and get a quickstart on development. When you deploy a template using the Deploy Button, the deployment may prompt you to install related integrations to connect with a third-party service.
  • Through a third party - Integration creators can prompt you to install their Vercel Integration through their app or website.

When installing or using an integration, your data may be collected or disclosed to Vercel. Your information may also be sent to the integration creator per our Privacy Notice . Third party integrations are available "as is" and not operated or controlled by Vercel. We suggest reviewing the terms and policies for the integration and/or contacting the integration creator directly for further information on their privacy practices.

You can manage which projects the installed integration has access to by going to the Integrations tab on your Vercel Dashboard and selecting the Manage button next to an installed Integration.

From here, you'll be able to:

If further configurations are required, you can also select the Configure button on this page.

Manage all your installed integrations.
Manage all your installed integrations.

Integration permissions restrict how much of the API the integration is allowed to access. When you install an integration, you will see an overview of what permissions the integration requires to work.

Permission TypeRead AccessWrite Access
InstallationReads whether the integration is installed for the hobby or team accountRemoves the installation for the hobby or team account
DeploymentRetrieves deployments for the hobby or team account. Includes build logs, a list of files and builds, and the file structure for a specific deploymentCreates, updates, and deletes deployments for the hobby or team account
Deployment ChecksN/ARetrieves, creates, and updates tests/assertions that trigger after deployments for the hobby or team account
ProjectRetrieves projects for the hobby or team account. Also includes retrieving all domains for an individual projectCreates, updates, and deletes projects for the hobby or team account
Project Environment VariablesN/AReads, creates, and updates integration-owned environment variables for the hobby or team account
Global Project Environment VariablesN/AReads, creates, and updates all environment variables for the hobby or team account
TeamAccesses team details for the account. Includes listing team membersN/A
Current UserAccesses information about the hobby account on which the integration is installedN/A
Log DrainsN/ARetrieves a list of log drains, creates new and removes existing ones for the Pro or Enterprise accounts
DomainRetrieves all domains for the hobby or team account. Includes reading its status and configurationRemoves a previously registered domain name from Vercel for the hobby or team account

Integrations can request more permissions over time. Individual users and team owners will be notified when an integration installation has pending permission changes.

Changed Permissions on Integration.
Changed Permissions on Integration.

You'll also be alerted to any new permissions on the dashboard. The permission request contains information on which permissions are changing and the reasoning behind the changes.

To manage which projects the installed integration has access to:

  1. From your Vercel dashboard, go to the Integrations tab
  2. Next to the integration, select the Manage button
  3. On the integrations page, under Access, select the Manage Access button
  4. From the dialog, select the option to manage which projects have access

To uninstall an integration:

  1. From your Vercel dashboard, go to the Integrations tab
  2. Next to the integration, select the Manage button
  3. At the bottom of the integrations page, under Uninstall, select Uninstall Integration and follow the steps to uninstall

Every integration installed for a team creates an access token that is associated with the developer who originally installed it. If the developer loses access to the team, the integration will become disabled to prevent unauthorized access. We will notify team owners when an installation becomes disabled.

When an integration is disabled, team owners must take action by clicking Manage and either changing ownership or removing the integration.

If a disabled integration is not re-enabled, it will be automatically removed after 30 days. Any environment variables that were created by that integration will also be removed - this may prevent new deployments from working.

When an integration is disabled:

  • The integration will no longer have API access to your team or account
  • If the integration has set up log drains, then logs will cease to flow
  • The integration will no longer receive the majority of webhooks, other than those essential to its operation (project.created, project.removed and integration-configuration.removed)

If you are an integrator, see the disabled integration configurations documentation to make sure your integration can handle disabled state.

Last updated on June 20, 2024