Skip to content
Docs

Get a webhook

GEThttps://api.vercel.com/v1/webhooks/{id}
Get a webhook
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.webhooks.getWebhook({
    id: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "alertRuleIds": [],
  "events": [],
  "id": "account_hook_GflD6EYyo7F4ViYS",
  "url": "https://my-webhook.com",
  "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
  "createdAt": "1567024758130",
  "updatedAt": "1567024758130",
  "projectIds": []
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idstringRequired

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
alertRuleIdsarrayOptional
eventsarrayRequired
The webhooks events
idstringRequired
The webhook id
urlstringRequired
A string with the URL of the webhook
ownerIdstringRequired
The unique ID of the team the webhook belongs to
createdAtnumberRequired
A number containing the date when the webhook was created in in milliseconds
updatedAtnumberRequired
A number containing the date when the webhook was updated in in milliseconds
projectIdsarrayOptional
The ID of the projects the webhook is associated with

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
410Error