API reference

Webhooks

List webhook subscriptions

Lists the webhook endpoints registered for a profile.

Required permission: `webhooks:read`

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

GET/v1/webhookswebhooks:read

Request

Authorization

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

Query parameters

profileIdstringoptional

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

Response

Returns 200.

WebhookSubscription[]required
supportedEventsstring[]required

Errors

Failures use the standard error format.

StatusCodeWhen it happens
401invalid_api_keyThe key does not exist, was revoked, or is malformed. Keys start with cdyn_live_.
403insufficient_permissionThe key is missing the scope this endpoint needs, for example posts:write on a readonly key.
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.