Webhook events - ScripX Docs

The events a webhook subscription can receive. Subscribe to one, or to * for all. GET /v1/webhooks always returns the live catalog; treat this page as the annotated version.

Event catalog

Event	Fires when
`order.matched`	Your order found its counterparty; settlement begins
`settlement.settled`	Delivery versus payment completed; the trade is done
`settlement.failed`	Settlement could not complete; the trade unwinds safely
`settlement.updated`	Umbrella event for intermediate settlement state changes
`credit.issued`	A new credit landed in your inventory and is tradable
`payout.sent`	Seller proceeds dispatched to the bank

The typical happy path for a sell: order.matched → settlement.settled → payout.sent.

Delivery contract

Every delivery is a POST with the signed-headers contract from the Webhooks guide: X-ScripX-Signature (sha256=<hmac> over the exact body), X-ScripX-Event, X-ScripX-Delivery.

Deliveries can repeat; dedupe on X-ScripX-Delivery.
Order between different events is not guaranteed under retry; re-read the resource for authoritative state.
Transient failures retry with backoff; permanent 4xx and exhausted retries dead-letter, and dead-letters are listable and replayable.

Webhooks guide, signature verification code.
Register a webhook

​Event catalog

​Delivery contract

​Related

Event catalog

Delivery contract

Related