Test webhook
Fires a synthetic event down the real delivery path.
- Authentication
- Bearer token
- Retries
- Idempotency-Key
- Body
- application/json
- Version
- 2026-09-03
Returns as soon as the delivery is queued - 202-shaped behaviour with a 200, because the result is a row the caller then polls for rather than something this request can wait on. Posting inline would be faster and would skip the queue, the retry classification and the failure accounting, so a test could pass on an endpoint every real delivery fails against.
The payload carries "test": true at the top level. A test event that a receiver cannot distinguish from a real one is a test that creates a real record in somebody's CRM.
Path parameters#
Headers#
Request body#
Responses#
Errors#
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
validation_error· 422 — The payload was well-formed JSON but failed schema validation.unauthenticated· 401 — The request carried no API key, or one the API could not verify.forbidden· 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.idempotency_key_reused· 422 — This `Idempotency-Key` was used before, for a request with a different body.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.
More Webhooks endpoints#
Something unclear or missing? Tell us and we’ll fix it.