Skip to main content
WEBHOOK
Configure a webhook when you submit a batch to receive batch.completed events. For other outcomes, see batch.failed and batch.cancelled. Use List Webhook Deliveries to inspect retained events and Retry a Webhook Delivery to resend one. Retrieve the batch for its current status and fresh result URLs.

Headers

User-Agent
string
required

Identifies the Context.dev webhook sender.

Example:

"Context.dev-Webhooks/1.0"

X-Context-Event
enum<string>
required

Which final status the batch reached. Matches the event field in the request body.

Available options:
batch.completed
X-Context-Id
string
required

Unique event ID. Matches the top-level id field in the request body.

Example:

"evt_123"

X-Context-Delivery-Id
string

Delivery ID for status checks and retries.

Example:

"whd_0123456789abcdef0123456789abcdef"

X-Context-Attempt
integer

Attempt number, starting at 1.

Required range: x >= 1
X-Context-Signature
string

HMAC signature in the form t=<unix>,v1=<hmac>. The HMAC is SHA-256 over "{t}.{rawRequestBody}", keyed with the webhook_secret from the submit response. Sent when a webhook was configured through either webhook or webhookUrl. Verify the unmodified request body with a constant-time comparison and reject stale timestamps.

Example:

"t=1783620012,v1=087d98aada1e39f9d24d65951f51e672da12b2f9ea1c02c7c8c5ef254f5d4068"

Body

application/json

Payload sent when a batch completes.

event
enum<string>
required

Which final status the batch reached. Mirrors the X-Context-Event header.

Available options:
batch.completed
id
string
required

Unique event ID. Mirrors the X-Context-Id header.

Example:

"evt_123"

created_at
string<date-time>
required

When the delivery was generated.

Example:

"2026-07-09T18:00:12.000Z"

data
object
required

Response

2XX

Webhook accepted.