API reference

Webhooks

List webhook deliveries

Returns the delivery log for one subscription, including response codes and the next scheduled retry.

Required permission: `webhooks:read`

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

GET/v1/webhooks/{id}/deliverieswebhooks:read

Request

Authorization

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

Path parameters

idstringrequired

Webhook subscription id.

Query parameters

profileIdstringoptional

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

statusenumoptional

One of:pendingdeliveredfailedall

limitintegeroptional

Page size, 1-100. Defaults to 50.

offsetintegeroptional

Rows to skip. Defaults to 0.

Response

Returns 200.

WebhookDelivery[]required
totalnumberrequired
maxAttemptsnumberrequired
retrySchedulenumber[]required
limitnumberrequired
offsetnumberrequired

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_.
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.