API reference

Webhooks

Send a test event

Delivers a synthetic event so you can verify your endpoint and signature check before waiting on real activity.

Required permission: `webhooks:write`

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

POST/v1/webhooks/{id}/testwebhooks: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.

eventTypeobjectoptional

Event type to simulate. Defaults to comment.received.

Response

Returns 202.

objectrequired

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.