Notifications
Event Catalogue
Every event we send, and the payload envelope.
Envelope
Every event has the same envelope:
| Field | Value |
|---|---|
event_id | Unique id. Also sent as x-idempotency-key. |
event_type | The event name. |
business_id | Your business. |
project_id | The project the event belongs to. |
customer_id | The customer, when there is one. |
occurred_at | When it happened. |
data | The event's details. |
Events
| Area | Events |
|---|---|
| Wallets | wallet.created, wallet.passkey.enrolled, wallet.passkey.revoked, wallet.passkey.removal_blocked |
| Transactions | transaction.approval_required, transaction.submitted, transaction.pending, transaction.success, transaction.failed, transaction.reconciled, transaction.reconciliation_expired, transaction.summary_corrected |
| Deposits | deposit.detected, deposit.confirmed |
| Bridges | bridge.filled, bridge.refunded, bridge.failed, bridge.stalled |
| Payments | payment.created, payment.detected, payment.approval_required, payment.approval_expired, payment.settled, payment.unclaimed, payment.recovered, payment.cancelled, payment.expired, payment.settlement_stalled |
| Recovery | recovery.code, recovery.started, recovery.reminder, recovery.completed, recovery.cancelled, recovery.failed |
recovery.cancelled carries a reason of token, passkey or business; accept all three.