Creates a webhook | Vercel REST API

APIs & SDKs

Creates a webhook

POSThttps://api.vercel.com/v1/webhooks

Creates a webhook

https://api.vercel.com/v1/webhooks

const response = await fetch('https://api.vercel.com/v1/webhooks?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "events": [],
    "projectIds": []
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "alertRuleIds": [],
  "createdAt": "1567024758130",
  "events": [],
  "id": "account_hook_GflD6EYyo7F4ViYS",
  "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
  "projectIds": [],
  "secret": "string",
  "updatedAt": "1567024758130",
  "url": "https://my-webhook.com"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

urlstringRequired

eventsarrayRequired

projectIdsarrayOptional

Response

200Success

alertRuleIdsarrayOptional

createdAtnumberRequired

A number containing the date when the webhook was created in in milliseconds

eventsarrayRequired

The webhooks events

idstringRequired

The webhook id

ownerIdstringRequired

The unique ID of the team the webhook belongs to

projectIdsarrayOptional

The ID of the projects the webhook is associated with

secretstringRequired

The webhook secret used to sign the payload

updatedAtnumberRequired

A number containing the date when the webhook was updated in in milliseconds

urlstringRequired

A string with the URL of the webhook

Errors

400One of the provided values in the request body is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: Creates a webhook (/docs/rest-api/webhooks/creates-a-webhook)

From the Vercel docs graph (built 2026-10-07T05:48:34.144Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Get a webhook — GET /v1/webhooks/{id} — Get a webhook
Get a list of webhooks — GET /v1/webhooks — Get a list of webhooks
Deletes a webhook — DELETE /v1/webhooks/{id} — Deletes a webhook
Setting Up Webhooks — Learn how to set up webhooks and use them with Vercel Integrations.
Returns activated WAF config — GET /v1/security/firewall/config — Lists WAF configs for a project

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/webhooks

const response = await fetch('https://api.vercel.com/v1/webhooks?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "events": [],
    "projectIds": []
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "alertRuleIds": [],
  "createdAt": "1567024758130",
  "events": [],
  "id": "account_hook_GflD6EYyo7F4ViYS",
  "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
  "projectIds": [],
  "secret": "string",
  "updatedAt": "1567024758130",
  "url": "https://my-webhook.com"
}

OpenAPI Specification