Bank webhook events are sent for live and sandbox applications.
Choose the events per destination with the destination’s event filter, as for other events.
See Webhooks for the envelope, the signature headers and retries.
Events
Every event also carries the common fields
event_id, webhook_type, timestamp, created_at, application_id and environment.
bank.link.* events carry their fields under data; the connection, data and sync events carry theirs at the top level.
ended_by is end_user, bank, customer or unknown.
The exact schema of every event is in the API reference.
Example
How to use them
- New data.
bank.data.updatedis a signal only: nothing is pushed. Call the change feed with your stored cursor. Usebank.sync.completedonly if you want to see every sync, including those that changed nothing. - Onboarding. Wait for
bank.connection.createdbefore you read accounts, and forbank.connection.history_completebefore you rely on the full history. - Consent. On
bank.connection.consent_expiringask the person to renew. Onbank.connection.renewal_requireddata is still readable but no longer synced. - Stop. On
bank.connection.revokedstop your own feed for that connection and decide whether to delete the stored data. - Duplicates. Treat every event idempotently: key on the event id, and expect the same event twice now and then.
- Never trust the browser. Confirm a link with
bank.link.completedorGET /v3/bank/links/{id}/, not with a link id sent by a page.
Next steps
- Continuous bank feed for accounting
- Sandbox: the Didit Test Bank fires these events.