Webhooks allow integration connectors to proactively notify the Toqio system when significant events occur within the Banking Provider's ecosystem, such as transaction updates or status changes. This ensures real-time synchronization between systems.
In a typical flow, for example for a payment, the user will create a payment in the UI and we will send a request to your connector. When this payment changes the status, e.g. from SETTLED to ACCEPTED, you must send a notification to the webhook service so that the transaction can be updated to the corresponding state.
Webhook Setup
Toqio will provide a specific URL to the integration connector where webhook notifications must be sent.
Authentication
Every webhook request sent to the Toqio system must be securely authenticated using an API key provided by Toqio.
Ensure that your integration securely stores and transmits this API key to maintain security.
Best Practices
- Immediate Notification: Send webhook notifications as soon as possible after an event occurs.
- Retry Logic: Implement retry mechanisms in case the initial webhook notification fails.
- Logging: Maintain comprehensive logs of webhook transactions for troubleshooting and auditing purposes.
To start working with our webhooks service you need first to ask our delivery team to create your service as defined in this page. Once you are setup you can start making requests to update objects.
To send a request to the service you will need to use these urls, based on the environment you want to invoke:
Sandbox -> https://core.sandbox.toq.io/webhooks/integration/[INTEGRATION]/webhookType/[WEBHOOK_TYPE]
Production -> https://core.toq.io/webhooks/integration/[INTEGRATION]/webhookType/[WEBHOOK_TYPE]
In this section you will find the different webhooks available and the body request for each of them.