Creating & Triggering Deploy Hooks

Deploy Hooks allow you to create URLs that accept HTTP POST requests in order to trigger deployments and re-run the Build Step. These URLs are uniquely linked to your project, repository, and branch, so there is no need to use any authentication mechanism or provide any payload to the POST request.

This feature allows you to integrate Vercel deployments with other systems. For example, you can set up:

• Automatic deployments on content changes from a Headless CMS
• Scheduled deployments by configuring third-party cron job services to trigger the Deploy Hook
• Forced deployments from the command line

To create a Deploy Hook for your project, make sure your project is connected to a Git repository.

Once your project is connected, navigate to its Settings page and then select the Git menu item.

In the "Deploy Hooks" section, choose a name for your Deploy Hook and select the branch that will be deployed when the generated URL is requested.

Creating a new Deploy Hook.

After submitting the form, you will see a URL that you can copy and use.

To trigger a Deploy Hook, send a GET or POST request to the provided URL.

Here's an example request and response you can use for testing:

curl -X POST https://api.vercel.com/v1/integrations/deploy/prj_98g22o5YUFVHlKOzj9vKPTyN2SDG/tKybBxqhQs

{
  "job": {
    "id": "okzCd50AIap1O31g0gne",
    "state": "PENDING",
    "createdAt": 1662825789999
  }
}

After sending a request, you can see that it triggered a deployment on your project dashboard.

Deployments triggered by a Deploy Hook are marked in the list.

When you create a Deploy Hook, a unique identifier is generated in the URL. This allows anyone with the URL to deploy your project, so treat it with the same security as you would any other token or password.

If you believe your Deploy Hook URL has been compromised, you can revoke it and create a new one.

Builds triggered by a Deploy Hook are automatically provided with an appropriate Build Cache by default, if it exists.

Caching helps speed up the Build Step, so we encourage you to keep the default behaviour. However, if you explicitly want to opt out of using a Build Cache, you can disable it by appending ?buildCache=false to the Deploy Hook URL.

Here is an example request that explicitly disables the Build Cache:

curl -X POST https://api.vercel.com/v1/integrations/deploy/prj_98g22o5YUFVHlKOzj9vKPTyN2SDG/tKybBxqhQs?buildCache=false

If you send multiple requests to deploy the same version of your project, previous deployments for the same Deploy Hook will be canceled to reduce build times.

• Hobby and Pro accounts have a limit of 5 deploy hooks per project. Enterprise accounts have a limit of 10 deploy hooks per project.