Webhook Endpoints Overview

This is a way to be notified in real time about events related to the api users that you have created.

You can configure webhook endpoints via the Admin portal when you add or edit your API clients.

Once that you start receiving webhooks you will be able to see a list of them when you drill down to the details of your API users.

Example webhook

{
    "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
    "eventType": "newTransactions",
    "userId": "5c79210bbac25ecb5e71ac40",
    "payload": {
        "accounts": [
            {
                "id": "6d0baf11-248e-4c11-9c04-97b7758b4e04",
                "transactions": [
                    "d520402a-d982-43ee-b1d1-bdfd282249ea",
                    "613586bf-dac9-4996-9c03-7194a7d62297"
                ]
            }
        ]
    }
}

Format

From the Client settings in the Admin Portal you can select either JSON or JWT formatting for the webhook messages that we send you. You can use either format at any time, including for live production clients. This is outlined in detail here Webhook Format

Schema

Name

Type

Description

id

string

Unique id of the webhook

eventType

string[enum]

Event id

userid

string

User id

payload

object

Payload of the event

Response

We expect a 20x response to mark the webhook as received.

Retries

At the moment we only try to send webhooks once to your registered endpoint.

Best Practices

When receiving transactions webhooks we recommend fetching them from our API to have the latest changes. Multiple transactions can be retrieved at once using our transactions endpoint

Testing

Some of this webhooks can be tested using our Test connections as explained in our Test our API section.

List of Webhooks

New Transaction

Updated Transactions

Restored Transactions

Deleted Transactions

Balance Threshold

Payment Completed

Payment Error

Reauth Reminder

Refresh Reminder


What’s Next