Skip to main content
WEBHOOK

Headers

X-WM-Signature
string
required

HMAC-SHA256 signature of the raw request body, keyed by the subscription secret, formatted as sha256=<lowercase-hex>.

Pattern: ^sha256=[0-9a-f]{64}$
Example:

"sha256=2b8c0d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c"

X-WM-Event
string
required

Event type. Currently always chokepoint.disruption.

Example:

"chokepoint.disruption"

X-WM-Delivery-Id
string
required

Unique delivery identifier (whd_ + 32 hex chars). Use it to dedupe retries and process deliveries idempotently.

Pattern: ^whd_[0-9a-f]{32}$
Example:

"whd_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d"

Body

application/json
subscriberId
string
required

The wh_-prefixed subscription receiving this alert.

chokepointId
string
required

Chokepoint that breached the threshold (e.g. suez).

score
number
required

Current disruption score of the chokepoint, 0-100.

alertThreshold
number
required

The subscription's configured alert threshold, 0-100.

triggeredAt
string<date-time>
required

ISO-8601 timestamp when the alert fired.

reason
string
required

Human-readable explanation for the alert.

details
object

Optional structured context for the disruption.

Response

2XX

Any 2xx acknowledges receipt. A non-2xx response or a delivery timeout marks the delivery failed.