Skip to main content
POST
Send a test webhook

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

Where run notifications (run.completed, run.failed) are delivered.

url
string<uri>
required

Your HTTPS receiver.

signature
boolean

Sign deliveries with your HMAC key (needs an active key, see startHmacKeyRotation).

Response

The delivery attempt and its outcome.

delivered
boolean
status_code
integer

Your receiver's HTTP status.

elapsed_ms
integer
event_id
string
error
string

Why the delivery failed, when it did.