™2 min read
resource.verbNaming convention
6 groupsEnquiry…consent
data.objectCarries the resource
All event types
| Type | Fires when | data.object |
|---|---|---|
enquiry.created | A public enquiry is submitted | enquiry |
enquiry.updated | An enquiry’s status changes | enquiry |
decision.completed | A lending decision is reached | decision |
decision.referred | A decision is referred for manual review | decision |
loan.activated | A loan is drawn down / goes live | loan |
loan.closed | A loan is fully repaid or written off | loan |
payment.succeeded | A scheduled repayment settles | payment |
payment.failed | A repayment attempt fails | payment |
account.updated | A customer account record changes | account |
consent.granted | A consent flag is set | consent |
consent.withdrawn | A consent flag is withdrawn | consent |
Naming and stability
Types follow resource.verb. New verbs may be added under an existing resource without notice, so ignore unknown types gracefully rather than erroring. An existing type’s meaning and payload shape never change within an API version.
Frequently asked questions
Will new event types break my handler?
Only if you error on unknown types. Route on the types you know and no-op the rest. New types are additive and announced in the developer changelog.
How do I test which events my endpoint receives?
Subscribe a sandbox endpoint to *, drive the corresponding action in test mode, and inspect the deliveries. See Test a webhook locally.
Funding for UK limited companies
Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.