Webhooks
Event types
Subscribe an endpoint to the types you need, or leave event_types empty to receive them all. Each event's data is a snapshot of the object named in object_type.
| Type | Object | Sent when |
|---|---|---|
user.created | User | A user is created |
user.kyc_status_changed | User | kyc_status changes |
user.terms_status_changed | User | terms_status changes |
user.deactivated | User | A user is deactivated |
transfer.created | Transfer | A transfer is created, including one created by a deposit |
transfer.state_changed | Transfer | Any state change |
deposit.received | Transfer | Fiat arrives for an on-ramp |
deposit.returned | Transfer | Fiat is sent back to the sender |
payout.returned | Transfer | The rail returns or rejects a payout |
deposit_account.deactivated | DepositAccount | A deposit account is deactivated |
webhook_endpoint.test | WebhookEndpoint | Test delivery |
New types may be added at any time. Acknowledge any type you don't handle with a 2xx so it isn't retried.