--- title: get-a-list-of-webhooks product: vercel url: /docs/rest-api/webhooks/get-a-list-of-webhooks type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about get-a-list-of-webhooks on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # Get a list of webhooks ```http GET /v1/webhooks ``` Get a list of webhooks ## Authentication **bearerToken**: HTTP bearer ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `projectId` | string. pattern: `^[a-zA-z0-9_]+$` | No | | | `teamId` | string | No | The Team identifier to perform the request on behalf of. | | `slug` | string | No | The Team slug to perform the request on behalf of. | ## Responses ### 200: No description Content-Type: `application/json` ```json { "oneOf": [ { "type": "array", "items": { "type": "object", "required": [ "createdAt", "events", "id", "ownerId", "projectsMetadata", "updatedAt", "url" ], "properties": { "projectsMetadata": { "type": "array", "nullable": true, "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "blitzjs", "nextjs", "gatsby", "remix", "react-router", "astro", "hexo", "eleventy", "docusaurus-2", "docusaurus", "preact", "solidstart-1", "solidstart", "dojo", "ember", "vue", "scully", "ionic-angular", "angular", "polymer", "svelte", "sveltekit", "sveltekit-1", "ionic-react", "create-react-app", "gridsome", "umijs", "sapper", "saber", "stencil", "nuxtjs", "redwoodjs", "hugo", "jekyll", "brunch", "middleman", "zola", "hydrogen", "vite", "tanstack-start", "vitepress", "vuepress", "parcel", "fastapi", "flask", "fasthtml", "django", "sanity-v3", "sanity", "storybook", "nitro", "hono", "express", "h3", "koa", "nestjs", "elysia", "fastify", "xmcp", "python", "ruby", "rust", "node", "go", "services" ], "nullable": true }, "latestDeployment": { "type": "string" } } } }, "events": { "type": "array", "description": "The webhooks events", "items": { "type": "string", "description": "The webhooks events", "enum": [ "budget.reached", "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.rollback", "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", "alerts.triggered", "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.renamed", "project.env-variable.created", "project.env-variable.updated", "project.env-variable.deleted", "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.overdue", "marketplace.invoice.refunded", "ai-gateway.balance-depleted", "ai-gateway.auto-reload.limit-reached", "observability.anomaly", "observability.anomaly-error", "observability.usage-anomaly", "observability.error-anomaly", "botid.anomaly", "flag.created", "flag.updated", "flag.deleted", "flag.segment.created", "flag.segment.updated", "flag.segment.deleted", "test-webhook", "message.created", "message.updated", "message.deleted", "thread.resolved", "thread.unresolved", "message.reaction-added", "message.reaction-removed", "message.mentioned", "comment.created", "comment.updated", "comment.deleted", "comment.resolved", "comment.unresolved", "comment.reaction-added", "comment.reaction-removed", "comment.mentioned" ] } }, "id": { "type": "string", "description": "The webhook id" }, "url": { "type": "string", "description": "A string with the URL of the webhook" }, "ownerId": { "type": "string", "description": "The unique ID of the team the webhook belongs to" }, "createdAt": { "type": "number", "description": "A number containing the date when the webhook was created in in milliseconds" }, "updatedAt": { "type": "number", "description": "A number containing the date when the webhook was updated in in milliseconds" }, "projectIds": { "type": "array", "description": "The ID of the projects the webhook is associated with", "items": { "type": "string" } } } } }, { "type": "array", "items": { "type": "object", "required": [ "createdAt", "events", "id", "ownerId", "updatedAt", "url" ], "properties": { "events": { "type": "array", "description": "The webhooks events", "items": { "type": "string", "description": "The webhooks events", "enum": [ "budget.reached", "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.rollback", "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", "alerts.triggered", "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.renamed", "project.env-variable.created", "project.env-variable.updated", "project.env-variable.deleted", "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.overdue", "marketplace.invoice.refunded", "ai-gateway.balance-depleted", "ai-gateway.auto-reload.limit-reached", "observability.anomaly", "observability.anomaly-error", "observability.usage-anomaly", "observability.error-anomaly", "botid.anomaly", "flag.created", "flag.updated", "flag.deleted", "flag.segment.created", "flag.segment.updated", "flag.segment.deleted", "test-webhook", "message.created", "message.updated", "message.deleted", "thread.resolved", "thread.unresolved", "message.reaction-added", "message.reaction-removed", "message.mentioned", "comment.created", "comment.updated", "comment.deleted", "comment.resolved", "comment.unresolved", "comment.reaction-added", "comment.reaction-removed", "comment.mentioned" ] } }, "id": { "type": "string", "description": "The webhook id" }, "url": { "type": "string", "description": "A string with the URL of the webhook" }, "ownerId": { "type": "string", "description": "The unique ID of the team the webhook belongs to" }, "createdAt": { "type": "number", "description": "A number containing the date when the webhook was created in in milliseconds" }, "updatedAt": { "type": "number", "description": "A number containing the date when the webhook was updated in in milliseconds" }, "projectIds": { "type": "array", "description": "The ID of the projects the webhook is associated with", "items": { "type": "string" } } } } } ] } ``` ### 400: One of the provided values in the request query is invalid. ### 401: The request is not authorized. ### 403: You do not have permission to access this resource. --- ## Related - [webhooks endpoints](/docs/rest-api#webhooks) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)