v45

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

Webhooks

Get webhook endpoint by ID

Retrieve details of a specific webhook endpoint by ID

get/webhooks/{webhookEndpointId}

webhookEndpointIdstring uuid required

ID for the webhook

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

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