A webhook is a service that allows one program to send data to another program as soon as an event has occurred.
You can create webhooks for the events described below. You must provide a URL for each webhook you create.
FriendlyScore will send a POST request to that URL when specific events occur.
|Webhook Type||Webhook Rule||Example POST|
|ACCOUNT_AUTHORIZATION_GRANTED||The event is triggered when bank account is re-authorized by Customer|
|ACCOUNT_AUTHORIZATION_LOST||The event is triggered when account access is no longer available and the Customer must re-authorize access to Friendlyscore|
|REPORT_AVAILABLE||The event is triggered when bank account data is shared for the first time and all processing steps including account holder verification, transaction classification and financial insights are completed.|
|REPORT_UPDATED||The event is triggered when new bank account data is available and all processing steps including account holder verification, transaction classification and financial insights are completed.|
|NEW_EVENT||The event is triggered when new event / alert has occurred. See also Events Dictionary|
|url||string||yes||Valid URL for webhook|
Was this article helpful?
Friendly Score UK Ltd.
42 Brook Street, Mayfair
London W1K 5DB
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)