Skip to content

Vercel Integrations receive platform events via webhooks.

The webhook is an HTTP endpoint which is configured to receive HTTP POST requests. After you create the endpoint in your app, you can add it to the Integration via the Integration Console.

Inside your Integration's settings page, there is a text field for setting the webhook URL. This is where you should add the HTTP endpoint mentioned above. You can toggle checkboxes to specify which events to listen to.

Specifying the webhook URL and events to listen to.

The webhook URL receives a HTTP POST request with a JSON payload for each event. All the events has the following format:

  "id": <eventId>,
  "type": <event-type>,
  "clientId": <clientId>,
  "createdAt": <javascript-timestamp>,
  "payload": <payload for the event>,
  "ownerId": <ownerId>,
  "teamId": <teamId>,
  "userId": <userId>,
  "webhookId": <webhookId>

Here's a list of supported event types and their payload.

After setting up the webhook URL, you are ready to receive payloads. Now anybody can send you requests by knowing the URL of your webhook. It's recommended that you secure your webhooks by using the x-vercel-signature security header .