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
generation
string
required
delivery_ids
integer<int64>[]
required
Required array length: 1 - 128 elements
Required range: x >= 1

Response

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

subscription_id
string<uuid>
subscription_version
integer
generation
string
delivery_ids
integer[]
payload_sha256
string[]
Pattern: ^[0-9a-fA-F]{64}$
policy_version
string
target_sha256
string
Pattern: ^[0-9a-fA-F]{64}$
maximum_credits
integer
resources
object
recoverable_until
string<date-time>
quote_sha256
string
Pattern: ^[0-9a-fA-F]{64}$