Events mark changes or behaviour in entities and can be used to trigger actions in your application.
Entities and their events
| entity | eventType | Description |
|---|---|---|
| connection | connection.created | when a connection is created |
| connection.deleted | when a connection is deleted | |
| consent | consent.created | when a consent is created |
| consent.expired | when a consent is expired | |
| consent.reminder | when a consent has been active for 90 days since the last update | |
| consent.revoked | when a consent is revoked | |
| consent.updated | when a consent is updated | |
| consent.warning | when a consent is about to expire | |
| payment-agreement-instruction | payment-agreement-instruction.failed | when an agreement instruction is failed |
| payment-agreement-instruction.successful | when an agreement instruction is successful | |
| payment-agreement | payment-agreement.active | when an agreement is active |
| payment-agreement.cancelled | when an agreement is cancelled | |
| payment-agreement.suspended | when an agreement is suspended | |
| payout | payout.created | when a payout is created |
| payout.failed | when a payout is failed | |
| payout.in-progress | when a payout is in-progress | |
| payout.successful | when a payout is successful | |
| payrequest | payrequest.created | when a payrequest is created |
| payrequest.failed | when a payrequest is failed | |
| payrequest.in-progress | when a payrequest is in-progress | |
| payrequest.successful | when a payrequest is successful | |
| user | user.created | when an user is created |
| user.deleted | when an user is deleted | |
| user.updated | when an user is updated |
Consent events
Any events around consent must be monitored if your application is using Open Banking data. For more information please read our documentation on data governance events.