WEBHOOKS
Webhook events
Every event type your integration can subscribe to, wrapped in the same delivery envelope. There are 30 event types across 11 categories — 28 live, 2 planned (catalogued ahead of the producing service; see each type's page for what "planned" means).
Delivery envelope
Every delivery is this envelope with data shaped by type.
idstring (uuid)required
Unique event id — use for dedupe.
type"programme.created" | "programme.updated" | "card_product.created" | "cardholder.created" | "cardholder.updated" | "kyc.check.started" | "kyc.check.completed" | "kyc.check.expired" | "card.created" | "card.transition" | "authorization.decided" | "transaction.cleared" | "clearing.exception.raised" | "clearing.posting_instruction.created" | "simulator.program.started" | "simulator.program.step.completed" | "simulator.program.completed" | "simulator.program.failed" | "ledger.entry.posted" | "ledger.funds.issued" | "ledger.settlement.cleared" | "ledger.funds.retired" | "ledger.hold.placed" | "ledger.hold.released" | "ledger.hold.captured" | "screening.snapshot.activated" | "screening.hit.raised" | "screening.hit.dispositioned" | "authorization.posting_instruction.issued" | "authorization.stip_outage.finished"required
Event type.
created_atstring (date-time)required
dataunknownrequired
The event payload; shape depends on `type`.
Example — card.created delivery
{
"id": "uuid",
"type": "card.created",
"created_at": "date-time",
"data": {
"card_id": "string",
"card_product_id": "string"
}
}