GET
/
v1
/
webhooks
getWebhooks
import { Vercel } from "@vercel/sdk";

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

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

  console.log(result);
}

run();
[
  {
    "projectsMetadata": [
      {
        "id": "<string>",
        "name": "<string>",
        "framework": "blitzjs",
        "latestDeployment": "<string>"
      }
    ],
    "events": "deployment.created",
    "id": "account_hook_GflD6EYyo7F4ViYS",
    "url": "https://my-webhook.com",
    "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
    "createdAt": 1567024758130,
    "updatedAt": 1567024758130,
    "projectIds": [
      "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectId
string
​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

​
projectsMetadata
object[] | null
required
​
events
enum<string>[]
required

The webhooks events

Example:

"deployment.created"

​
id
string
required

The webhook id

Example:

"account_hook_GflD6EYyo7F4ViYS"

​
url
string
required

A string with the URL of the webhook

Example:

"https://my-webhook.com"

​
ownerId
string
required

The unique ID of the team the webhook belongs to

Example:

"ZspSRT4ljIEEmMHgoDwKWDei"

​
createdAt
number
required

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

Example:

1567024758130

​
updatedAt
number
required

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

Example:

1567024758130

​
projectIds
string[]

The ID of the projects the webhook is associated with

Example:
["prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"]