Skip to main content
POST
Send a synthetic test event to a webhook URL

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Body

application/json

Body for POST /v1/webhook/test. Same shape as the submit-time webhook field; signature is optional and defaults false.

url
string<uri>
required

HTTPS only. Host must resolve via DNS within 1 second. Identical validation to the submit/PUT webhook URL.

signature
boolean
default:false

When true, the test event is signed with the account's active HMAC key: same X-Signature: t,v1,kid header real deliveries use. Returns 400 webhook_signing_requires_active_key when no active key exists.

Response

Dispatch attempted. Inspect delivered to see whether the receiver returned 2xx.

Outcome of the synthetic test dispatch. HTTP status is always 200 when the request was validated: the receiver outcome is in the body. The synthetic envelope uses event_type: "webhook.test" and stable sentinel IDs (job_id/run_id = "test") so receivers can recognise and discard test traffic.

delivered
boolean
required

true iff the receiver responded with a 2xx status. false on non-2xx, timeout, or transport error.

event_id
string
required

ID of the synthetic event. Different on every call so receivers' dedup tables don't suppress repeated tests.

elapsed_ms
integer
required

Wall-clock duration of the receiver POST in milliseconds.

status_code
integer

HTTP status returned by the receiver. Absent on timeout or transport error (no response was received).

error
string

Human-readable reason when delivered: false. Same vocabulary as real webhook deliveries (http_4xx:<code>, http_5xx:<code>, timeout, transport_error:<detail>). Absent on success.