Sign in

v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-2684278289.5 KB
Webhooks

Create a new webhook endpoint

Register a new webhook endpoint to receive event notifications

post/webhooks

Request body

eventTypesWebhookEventType[] nullable

Optional array of event types to subscribe to. Nothing means subscribe to all event types.

filterPathsResourceField[] nullable

Optional array of resource field paths to filter events by. When specified, webhook events will only be sent when one of these fields changes. Nothing means no filtering (all events are sent).

urlstring required

The URL to which webhook events will be delivered

Response

createdAtstring yyyy-mm-ddThh:MM:ssZ required

When the webhook was created

eventTypesWebhookEventType[] nullable

Optional array of event types this webhook is subscribed to. Nothing means all events.

filterPathsResourceField[] nullable

Optional array of resource field paths to filter events by. Nothing means no filtering.

idstring uuid required

Unique identifier for the webhook endpoint

secretstring nullable

Webhook signing secret. Only returned on creation (POST), not on GET or UPDATE operations.

status'active' | 'paused' | 'disabled' required

Current status of the webhook (active, paused, or disabled)

updatedAtstring yyyy-mm-ddThh:MM:ssZ required

When the webhook was last updated

urlstring required

The URL that will receive webhook POST requests

Example response

{
  "createdAt": "2016-07-22T00:00:00Z",
  "updatedAt": "2016-07-22T00:00:00Z"
}