Sign in

v45

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

Update an existing webhook endpoint

Update the configuration of an existing webhook endpoint. A webhook that has been disabled due to consecutive delivery failures can be reactivated by setting its status to 'active'.

post/webhooks/{webhookEndpointId}

Path parameters

webhookEndpointIdstring uuid required

ID for the webhook

Request body

eventTypesWebhookEventType[] nullable

Event types to subscribe to. Send null to subscribe to all event types. Send an array to subscribe to specific types. Omit to leave unchanged.

filterPathsResourceField[] nullable

Resource field paths to filter events by. When specified, webhook events will only be sent when one of these fields changes. Send null for no filtering. Send an array to filter by specific fields. Omit to leave unchanged.

status'active' | 'paused' nullable

Webhook status. Only 'active' and 'paused' values are allowed. Omit to leave unchanged.

urlstring nullable

The URL to which webhook events will be delivered. Omit to leave unchanged.

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"
}