Test Webhook V1
Send a probe POST to verify a webhook URL is reachable. The probe carries the same envelope shape and headers as a real job.completed delivery (with a…
POST
Send a probe POST to verify a webhook URL is reachable.
The probe carries the same envelope shape and headers as a
real
job.completed delivery (with a synthetic flat payload
underneath), so the receiver is tested end-to-end before a real
job is queued. Returns delivery status and round-trip latency.
Envelope fields (event_id, event_type, event_timestamp,
api_version) are stamped exactly like production deliveries —
tenants writing receivers against this probe see the same shape
they’ll see when a real job completes.
Request body
WebhookTestRequest
string
required
Webhook URL to probe. http or https only.
string,null
Optional shared secret. When set, the probe carries an
X-Webhook-Signature header signed with the same scheme as production deliveries.Response
WebhookTestResponse
boolean
required
True iff the receiver returned 2xx.
integer,null
HTTP status the receiver returned. None when the request could not complete (network error, timeout).
integer
required
Wall-clock time the probe took, in milliseconds.
string,null
Network / timeout error message when delivery failed.