API reference

Webhooks

Update a webhook subscription

Changes the URL or event list, or pauses delivery with isActive: false. A paused subscription keeps its secret and its delivery history.

Required permission: `webhooks:write`

Accepts `profileId` to target a specific profile. Omit it to use the key’s home profile.

PATCH/v1/webhooks/{id}webhooks:write

Request

Authorization

Send your API key as a Bearer token in the Authorization header.

Path parameters

idstringrequired

Webhook subscription id.

Request body

profileIdstringoptional

Profile to act on. Defaults to the profile the API key was created in.

urlstringoptional

HTTPS endpoint that receives POSTs.

eventsenum[]optional

Replaces the current event list.

isActivebooleanoptional

Set false to stop delivering without deleting.

Response

Returns 200.

WebhookSubscriptionrequired

Errors

Failures use the standard error format.

StatusCodeWhen it happens
400invalid_requestThe request body or query string failed validation. The message names the offending field.
401invalid_api_keyThe key does not exist, was revoked, or is malformed. Keys start with cdyn_live_.
404not_foundThe resource does not exist inside the resolved profile.
429rate_limit_exceededToo many requests for this key. Honour the Retry-After header before retrying.
500internal_errorSomething failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists.