Sign in

v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB
Webhooks

Update Webhook

Update a webhook configuration. Requires API key with webhook:write.

patch/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required

Webhook ID (MongoDB ObjectId)

Request body

urlstring uri

The webhook endpoint URL (must be HTTPS)

eventsstring[]

Array of event types to subscribe to

activeboolean

Whether the webhook is active

descriptionstring

Optional description for the webhook

customHeadersobject

Optional custom headers to include in webhook requests

Response

Webhook updated

successboolean required
errorstring nullable