A webhook is a mechanism that allows us to notify your server about a specific action that took place on Fintoc's side so that your application can react to it, maintaining a "synchronized state" with Fintoc.

We use webhooks to notify your application when important events happen on your users' bank accounts. For instance, when a user changes its password and it is no longer possible to obtain new movements, or when a check is protested and the movement corresponding to said check ceases to exist in the bank. We also use webhooks to notify about events that happen on Fintoc itself. For instance, when an account finishes syncing with the latest available data from the bank.

To use the Fintoc webhooks, you need to follow three steps:

  • Create a webhook endpoint on your server (an endpoint that will receive the webhooks).
  • Test the webhook endpoint with some test events.
  • Register the webhook endpoint in Fintoc.

A webhook endpoint is just a few lines of code within your application. It should be associated with a URL that will be used to notify you about new actions. These notifications sent by Fintoc correspond to objects with the Event object type, which contains all the relevant information about what just happened. The webhook endpoint should use this information to perform any necessary action to maintain the correct state in the application. For example, requiring that a user re-connects its bank account with Fintoc after changing the bank account's password.