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)

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

Webhook updated

successboolean required

errorstring nullable

No recorded changes to this endpoint across all 5 revisions of this API.