v1

latestOpenAPI 3.1.02026-07-26102934.7 KB
webhooks

Update webhook

Updates an existing webhook. Only include the fields you want to change — omitted fields remain unchanged. Fields cannot be set to null.

patch/webhooks/{webhook_id}

Path parameters

webhook_idstring required

The webhook ID (e.g., whk_abc123).

Request body

urlstring nullable

New HTTPS URL. Max 2048 characters.

eventsWebhookEvent[] nullable

New list of subscribed events. Replaces the existing list. At least one event is required.

enabledboolean nullable

Enable or disable the webhook.

Response

The updated webhook.

idstring required

Webhook ID.

urlstring required

The registered URL.

eventsWebhookEvent[] required

Subscribed events.

enabledboolean required

Whether the webhook is active.

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

Example response

{
  "id": "whk_abc123"
}