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, 1 to 128 characters. Resending the same key within seven days returns the first test instead of sending another.

Required string length: 1 - 128
Example:

"test-0001"

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"

Response

The test was sent; status says how the receiver answered.

id
integer<int64>
required
subscription_id
string<uuid>
required
event_id
string
required
status
enum<string>
required
Available options:
started,
delivered,
rejected,
uncertain
created_at
string<date-time>
required
response_code
integer
last_error
string
completed_at
string<date-time>