Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer whk_…, a webhook key from the dashboard. Webhook keys belong to one network, so pick the server that matches the key. lum_ API keys are not accepted here (401).

Headers

If-Match
string
required

The ETag from GET /v1/subscriptions/{id}, for example "1" (the weak form W/"1" that some proxies produce is accepted too). A stale version returns 412; a missing header returns 428.

Pattern: ^(W/)?"[1-9][0-9]*"$
Example:

"\"1\""

Idempotency-Key
string
required

Required. Choose one key per change and resend it unchanged on a retry: the same key with the same request returns the first result instead of applying the change again, and the same key with a different request returns 409.

Required string length: 1 - 128
Example:

"retry-0001-2026-10-22"

Path Parameters

id
string<uuid>
required

Endpoint (subscription) ID from POST /v1/subscriptions or GET /v1/subscriptions. The example ID is a placeholder and answers 404: use your own.

Example:

"00000000-0000-4000-8000-000000000000"

Body

application/json
generation
string
required
first_ledger
integer
required
Required range: x >= 3
last_ledger
integer
required

Inclusive end; must satisfy the selected bounded source policy.

max_deliveries
integer
required
Required range: x >= 1
quote_sha256
string
required

quote_sha256 from the quote response.

Pattern: ^[0-9a-fA-F]{64}$

Response

The same Idempotency-Key was sent before: the existing job.

kind
enum<string>
required

retained: a redelivery of retained payloads; source: a source replay.

Available options:
retained,
source
id
string<uuid>
required
subscription_id
string<uuid>
required
generation
string
required
state
string
required
pending
integer
required
delivered
integer
required
dead
integer
required
in_flight
integer
required
created_at
string<date-time>
required
source_quote
object
source_phase
string
source_attempts
integer
failure_code
string
quote
object