Webhooks

Algoan uses webhooks to notify your application when an event occurs during the Open Banking process. A webhook is a real-time notification to your server, using HTTPS requests and JSON payloads.

Format

An event sent by Algoan is a POST request. Here is an overview of the request body:

JSON
    
 
{  "subscription": {    "id": "2118ac3d2e202f98759489f2",    "target": "https://your-end-point.com/webhook/",    "eventName": "analysis_completed",  },  "payload": {    "customerId": "...",    "analysisId": "...",    "sessionId" : "..." //only for Transaction Data users  },  "time": 1458692752478,  "index": 1}
Copy

It contains:

subscription : The subscription entity called.
payload: The payload including only model identifiers related to the event.
time: The time when the event has been emitted (number of milliseconds since the Unix epoch in UTC).
index: Event's index in the list of all events emitted for this subscription and this application.

Event list

You can subscribe to the below list of events:

Name	Description
`bank_details_fetched`	Triggers when the Open Banking data has been uploaded for a Customer.
`analysis_completed`	Triggers when Score and Credit Insights have been computed and added to the Analysis.
`analysis_failed`	Triggers when an error occurred on the Analysis.
`session_connect_state_changed`	Triggers when a state changes as an end user interacts with the Transaction Data journey.
`report_completed`	Triggers when a Report has been created.
`report_failed`	Triggers when an error occurred during the Report creation. For exemple, when there is only one analysis for the "ANALYSIS_COMPARISON" report.

Last updated on Jan 21, 2025

Was this page helpful?