Jump to Content

Webhooks Events Catalog

Event	Product	Fired when
`PaymentStatusChanged`	Payment links / Payment Requests	Every status transition of a payment request
PaymentStatusChanged	Bulk Payouts	Status of a bulk payout batch changes — same event name as for single payments, different payload shape (see Bulk Payouts Webhook)
`MandateStatusChanged`	Direct Debit Mandate	Status of a direct-debit authorization changes
`MandateDataChanged`	Mandate	Underlying mandate data (amount, frequency, etc.) changes
`MandateAboutToExpire`	Mandate	Up to 30 days before a mandate's `validUntil`
`UserInsightReady`	Insights Report	A user's financial insights report finishes computing
`ConsentStatusChanged`	Data consents	A user's data-access consent changes status
UserDataIsAvailable	Data consents	A consent is valid and data is available for retrieval.
ConsentAboutToExpire	AIS	Up to 30 days before a consent's `validUntil` date.
ConsentNotAccessed	AIS	A consent has been revoked due to inactivity of over 6 months.
DataRefreshComplete	AIS	Data retrieval interval has been completed.

Financial Events catalog

Event	`event` value	Status
Outstanding balance	`OutstandingBalance`	Live
Salary from a new employer	`NewSalary`	Live
Child birth	`NewChild`	Live
New insurance policy	`NewInsurancePolicy`	Live
Car insurance about to expire	`expiringCarInsurance`	Live
House insurance about to expire	`expiringHouseInsurance`	Live
Health insurance about to expire	`expiringHealthInsurance`	Live
Life insurance about to expire	`expiringLifeInsurance`	Live
Loan payment about to end	`expiringLoan`	Coming soon — not yet live
Deposit about to reach exit point	`depositExitPoint`	Coming soon — not yet live

Updated about 1 month ago

Did this page help you?