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\""

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

At most 64 consecutive inclusive ledgers and 128 deliveries, further bounded by the selected source policy.

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: 1 <= x <= 128

Response

The quote: maximum credits and the hash to start it with.

protocol
string
subscription_id
string<uuid>
subscription_version
integer
network
enum<string>
Available options:
mainnet,
testnet
request
object

At most 64 consecutive inclusive ledgers and 128 deliveries, further bounded by the selected source policy.

source_policy_version
string
delivery_policy_version
string
target_sha256
string
Pattern: ^[0-9a-fA-F]{64}$
maximum_credits
integer
source_success_credits
integer
source_bounds
object
source_max_attempts
integer
resources
object
quote_sha256
string
Pattern: ^[0-9a-fA-F]{64}$