Create webhook

POST

/public/v3/webhooks

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.

Planky will send a POST request to that URL when specific events occur.

Webhook TypeWebhook RuleExample POST
ACCOUNT_AUTHORIZATION_GRANTEDThe event is triggered when bank account is re-authorized by Customer
ACCOUNT_AUTHORIZATION_LOSTThe event is triggered when account access is no longer available and the Customer must re-authorize access to Friendlyscore
REPORT_AVAILABLEThe 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_UPDATEDThe 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_EVENTThe event is triggered when new event / alert has occurred. See also Events Dictionary

Parameters

none

Query parameters

none

Request Body Parameters

ParameterData typeRequired?Description
urlstringyesValid URL for webhook
commentstringnoOptional comment

Response Body Parameters

ParameterData typeRequired?Description
idstringyesWebhook ID

Request example

Response example:

Was this article helpful?

Friendly Score UK Ltd.

41 Luke Street

London EC2A 4DP

Call us on +44 20 3996 3540

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)