Skip to main content
GET
Read the current webhook config

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.

Path Parameters

job_id
string
required

Assigned by the server on submit.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Webhook is configured.

Webhook delivery config for run.completed / run.failed. Returned on GET /v1/jobs/{id} (inline under webhook) and on GET /v1/jobs/{id}/webhook. PUT requires both fields: no defaulting at the mutate boundary (otherwise toggling url would silently disable signing). Submit body accepts the same shape with signature optional (defaults false).

Delivery: one event per run that completes or fails on its own (a run stopped with /stop sends none), retried with backoff for up to 3 days, so the same event can arrive more than once; dedupe on X-ZenRows-Event-Id. Read GET /v1/jobs/{id} when you need to be sure a run finished.

url
string<uri>
required

HTTPS only. Host must resolve via DNS within 1 second (1+ A/AAAA record).

signature
boolean
required

Opt-in HMAC signing. When true, each delivery is signed with the account's active HMAC key (POST /v1/hmac/keys/rotate) and carries X-Signature: t=<unix>,v1=<hex>,kid=<active>. The signed input is t + "." + raw_body, HMAC-SHA256, keyed with the secret's raw bytes: base64-decode the secret that /rotate returned before using it. When false, deliveries carry no X-Signature header: header absence is the signal.