Get a subscription
Returns one endpoint with its filters, state and checkpoints. The ETag header carries its version: send it as If-Match on every change. Free endpoints include today’s free_quota; paid endpoints include paid (plan, endpoint limit and credits per delivery). A deleted endpoint still answers 200 with effective_state deleted.
Authorizations
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).
Path Parameters
Endpoint (subscription) ID from POST /v1/subscriptions or GET /v1/subscriptions. The example ID is a placeholder and answers 404: use your own.
"00000000-0000-4000-8000-000000000000"
Response
The endpoint, with its version in the ETag header.
HTTPS URL that receives the signed POSTs.
True while the endpoint receives events.
Delivery protocol version (2: deliveries carry a signed context).
Endpoint version, also in the ETag header. Every change increments it.
What you asked for: active, paused or deleted.
What applies now: active, activating, paused_by_user, paused_by_funding (for example the free daily cap was reached) or deleted.
metered for paid-plan endpoints, sponsored for the free Testnet endpoint, held for prepaid funded endpoints.
True for the one free Testnet endpoint of a Free organization: deliveries are not charged credits but are capped per UTC day, and replays are not available.
True for a paid-plan endpoint: every delivered Mainnet event costs the catalog webhook credit weight (1 credit) from the organization's monthly balance, with overage billed on paid plans. Testnet deliveries, and failed, cancelled and expired deliveries, cost nothing. Replays are not yet available for paid endpoints.
Version of the current signing secret; rotation increments it.
Endpoint label.
Returned only by the first successful creation; retries do not reveal it.
Account filter, when set.
Asset filter, when set.
Contract filter, when set.
Event type filter; absent or empty means every decoded event type.
Event index generation the endpoint reads.
The endpoint receives events from the ledger after this one. Read earlier history from the Activity API.
Last ledger the endpoint's state applies to.
Last ledger scanned for matching events.
Last ledger whose matching events were all queued for delivery.
Free Testnet endpoints only, on GET /v1/subscriptions/{id}: the organization's admitted and delivered deliveries today (UTC) against its daily cap.
Paid endpoints only, on GET /v1/subscriptions/{id}.
Create and update responses only: non-fatal filter warnings, such as a probable event type typo.