Sign in
Webhooks

Create a new webhook

post/projects/{project_id}/webhooks

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/webhooks
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Request body

enabledboolean nullable

Whether the webhook is enabled

eventsstring[] required

Event types to subscribe to

secretstring nullable

Secret for HMAC signature verification (optional)

urlstring required

Target URL for webhook delivery

Example request

{
  "events": [
    "deployment.created",
    "deployment.succeeded"
  ],
  "url": "https://example.com/webhook"
}

Response

Webhook created

created_atstring date-time required
enabledboolean required
eventsstring[] required
has_secretboolean required
idinteger required
project_idinteger required
updated_atstring date-time required
urlstring required

Example response

{
  "created_at": "2025-10-12T12:15:47.609192Z",
  "updated_at": "2025-10-12T12:15:47.609192Z"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.