How can I use webhooks?

Belvo provides a set of webhooks to help you build a more proactive and immersive experience for your users.

A webhook is a web callback that Belvo can use to send notification events specific to a link, for example when new transactions are available or when the credentials are not working anymore.

The webhooks are only working for recurrent links with bank institutions. 

We currently notify the webhook on two events: 

• new_transactions_available: whenever there are new transactions available for a recurrent link
• invalid_credentials: whenever a recurrent link credentials are not working anymore

1. Setup your webhooks 

Using your dashboard, you can setup one or more webhooks. 

You can find how to setup your webhook in our dedicated article.

2. Receive notifications

Once your webhook is created, you will start being notified on events happening to each of your recurrent links.

These notifications will be POST requests to your URL with a JSON payload depending on the event. For example: 

{
 "webhook_type": "TRANSACTIONS",
 "webhook_code": "new_transactions_available",
 "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
 "data": {
 "new_transactions": 19
 }
}

3. Pull data

After receiving the notification, you can call the Belvo API using your Secret Key to instantly access the new data.

For example if you want to access the new transactions (collected on 2020-01-01): 

curl --request GET 'https://api.belvo.co/api/transactions/?link=16f68516-bcbc-4cf7-b815-c500d4204e28&collected_at__range=2020-01-01,2020-01-02' \
-u [Secret Key ID]:[Secret Key PASSWORD]