Upgrade an Integration

You should upgrade your integration if you are using any of the following scenarios.

If your Integration is using outdated features on the Vercel Platform, follow these guidelines to upgrade your Integration and use the latest features.

Once ready, make sure to submit your Integration for review after you upgraded it.

You can now specify a generic Webhook URL in your Integration settings. Use generic Webhooks instead of Webhooks APIs and Delete Hooks.

The Vercel REST API to list, create, and delete Webhooks has been removed. There's also no support for Delete Hooks which are notified on Integration Configuration removal. If you have been using either or both features, you need to update your Integration.

If your Integration is using the OAuth2 installation flow, you should use the External installation flow instead. By using the External flow, users will be able to choose which Vercel scope (Personal Account or Team) to install your Integration to.

UI Hooks is a deprecated feature that allowed you to create custom configuration UI for your Integration inside the Vercel dashboard. If your Integration is using UI Hooks, you should build your own UI instead.

Integration that use UI Hooks are now fully deprecated. Users are not able to install them anymore.

If you are using a Legacy Integrations, it's recommended finding an updated Integration on the Integrations Marketplace. If adequate replacement is not available, contact the integration developer for more information.

If your Integration is not using currentProjectId to determine the target project for the Deploy Button flow, please use it. Here’s the documentation.

If your Integration assumes that it can be installed multiple times in a Vercel scope (Hobby team or team), read the following so that it can support single installation per scope for each flow:

• Marketplace flow
• External flow
• Deploy Button flow

If your Integration is setting Environment Variables, please make sure to use type=encrypted with the latest version (v7) of the API when creating Environment Variables for a Project.