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 by hooking into content changes in Headless CMSs.
  • Scheduled deployments by configuring third-party cron job services to trigger the Deploy Hook.
  • Forced deployments from the command line.

Creating a Deploy Hook

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.

Selecting the Git menu item from the Project Settings page.

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.

Note: We suggest you use a name that easily identifies the Deploy Hook so you will be able to understand when it triggers a deployment. We also suggest creating only one Deploy Hook per branch unless you’re using multiple data sources.

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

Triggering a Deploy Hook

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

Warning: Deploy Hooks will not be triggered if you have the github.enabled = false configuration present in a vercel.json file.

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

Example Request

curl -X POST https://api.vercel.com/v1/integrations/deploy/QmcwKGEbAyFtfybXBxvuSjFT54dc5dRLmAYNB5jxxXsbeZ/hUg65Lj4CV

Example Response

{
  "job": {
    "id": "A7OcAEEgNRh61p1VZXE1",
    "state": "PENDING",
    "createdAt": 1564399503217
  }
}

Information for a successful Deploy Hook job.

Note: You do not need to add any authorization header. See Security to learn more.

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

Security

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.

Build Cache

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/QmcwKGEbAyFtfybXBxvuSjFT54dc5dRLmAYNB5jxxXsbeZ/hUg65Lj4CV?buildCache=false
Note: Deploy Hooks created before May 11th, 2021 do not have the Build Cache enabled by default. To change it, you can either explictly append ?buildCache=trueto the Deploy Hook URL, or replace your existing Deploy Hook with a newly created one.

Other Optimizations

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.


Last Edited on May 28th 2021