Skip to main content
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

  • Option 1 · object[]
  • Option 2 · object[]
​
projectsMetadata
object[] | null
required
​
events
enum<string>[]
required

The webhooks events

The webhooks events

Available options:
budget.reached,
budget.reset,
domain.created,
domain.dns.records.changed,
domain.transfer-in.started,
domain.transfer-in.completed,
domain.transfer-in.failed,
domain.certificate.add,
domain.certificate.add.failed,
domain.certificate.renew,
domain.certificate.renew.failed,
domain.certificate.deleted,
domain.renewal,
domain.renewal.failed,
domain.auto-renew.changed,
deployment.created,
deployment.cleanup,
deployment.error,
deployment.canceled,
deployment.succeeded,
deployment.ready,
deployment.check-rerequested,
deployment.promoted,
deployment.integration.action.start,
deployment.integration.action.cancel,
deployment.integration.action.cleanup,
deployment.checkrun.start,
deployment.checkrun.cancel,
edge-config.created,
edge-config.deleted,
edge-config.items.updated,
firewall.attack,
firewall.system-rule-anomaly,
firewall.custom-rule-anomaly,
integration-configuration.permission-upgraded,
integration-configuration.removed,
integration-configuration.scope-change-confirmed,
integration-configuration.transferred,
integration-resource.project-connected,
integration-resource.project-disconnected,
project.created,
project.removed,
project.domain.created,
project.domain.updated,
project.domain.deleted,
project.domain.verified,
project.domain.unverified,
project.domain.moved,
project.rolling-release.started,
project.rolling-release.aborted,
project.rolling-release.completed,
project.rolling-release.approved,
deployment.checks.failed,
deployment.checks.succeeded,
deployment-checks-completed,
deployment-ready,
deployment-prepared,
deployment-error,
deployment-check-rerequested,
deployment-canceled,
project-created,
project-removed,
domain-created,
deployment,
integration-configuration-permission-updated,
integration-configuration-removed,
integration-configuration-scope-change-confirmed,
marketplace.member.changed,
marketplace.invoice.created,
marketplace.invoice.paid,
marketplace.invoice.notpaid,
marketplace.invoice.refunded,
observability.anomaly,
observability.anomaly-error,
observability.usage-anomaly,
observability.error-anomaly,
observability.anomaly-botId,
test-webhook
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"]