webhooks

Reference

Webhooks

Creates a webhook

post/v1/webhooks

Creates a webhook

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "events": "SOME_ARRAY OF STRING_VALUE",
4    "url": "SOME_STRING_VALUE",
5    "projectIds": "SOME_ARRAY OF STRING_VALUE"
6  },
7  "headers": {
8    "Authorization": "Bearer <TOKEN>"
9  },
10  "method": "post"
11})

Parameters

Query Params

Body Params

Query Parameter	Description
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

createdAtnumberRequired
A number containing the date when the webhook was created in in milliseconds
Example: 1567024758130

eventsarrayRequired
The webhooks events
Example: deployment.created

idstringRequired
The webhook id
Example: account_hook_GflD6EYyo7F4ViYS

ownerIdstringRequired
The unique ID of the team the webhook belongs to
Example: ZspSRT4ljIEEmMHgoDwKWDei

projectIdsarray
The ID of the projects the webhook is associated with
Example: ["prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"]

secretstringRequired
The webhook secret used to sign the payload

updatedAtnumberRequired
A number containing the date when the webhook was updated in in milliseconds
Example: 1567024758130

urlstringRequired
A string with the URL of the webhook
Example: https://my-webhook.com

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "events": "SOME_ARRAY OF STRING_VALUE",
4    "url": "SOME_STRING_VALUE",
5    "projectIds": "SOME_ARRAY OF STRING_VALUE"
6  },
7  "headers": {
8    "Authorization": "Bearer <TOKEN>"
9  },
10  "method": "post"
11})

Deletes a webhook

delete/v1/webhooks/{id}

Deletes a webhook

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
id	string required

Response

N/A

Response Codes

Code	Description
`204`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Get a webhook

get/v1/webhooks/{id}

Get a webhook

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
id	string required

Response

createdAtnumberRequired
A number containing the date when the webhook was created in in milliseconds
Example: 1567024758130

eventsarrayRequired
The webhooks events
Example: deployment.created

idstringRequired
The webhook id
Example: account_hook_GflD6EYyo7F4ViYS

ownerIdstringRequired
The unique ID of the team the webhook belongs to
Example: ZspSRT4ljIEEmMHgoDwKWDei

projectIdsarray
The ID of the projects the webhook is associated with
Example: ["prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"]

updatedAtnumberRequired
A number containing the date when the webhook was updated in in milliseconds
Example: 1567024758130

urlstringRequired
A string with the URL of the webhook
Example: https://my-webhook.com

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get a list of webhooks

get/v1/webhooks

Get a list of webhooks

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks?projectId=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Query Params

Query Parameter	Description
projectId	string
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

One of the following objects
One of

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/webhooks?projectId=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Last updated on November 7, 2024

Delete User Account

Creates a webhook

Was this helpful?