API Reference

Webhooks

Describe what is the webhook and its installation in details

Overview

Use incoming webhooks to get real-time updates. Listen for events from ThirdFi, so your integration can automatically trigger reactions.

ThirdFi use webhooks to notify your application when an event happens in your account activity. Webhooks are particularly useful for asynchronous events like when a user's transaction succeeds on blockchain networks, a customer's bank confirms a payment.

📘

Prevent spamming the status updates checking? Register your webhook endpoint on the Dashboard so ThirdFi knows where to deliver events.

Why use webhooks

Let's say you've registered to receive the dex.swap event and a customer clicks the "Confirm" button in your app or website to execute transaction. A webhook between Securo and your app tells your app whether the customer's transaction is successful or not. After your webhook endpoint receives the dex.swap event, your webhook function can then run backend actions to fulfill an order as updating your transaction record API to show the transaction is completed. Using an API for this workflow is like calling the API every millisecond to ask, was the payment successful?

Installation

Register endpoints in the Dashboard

ThirdFi needs to know where to send the events. To register your webhook endpoint, provide the publicly accessible HTTPS URL with POST method to webhook endpoint.

Webhook URL format
The URL format to register a webhook endpoint is:

https://<your-domain-name>/<your-webhook-endpoint>

For example, if your domain name is https://example.com and the route to your webhook endpoint is @app.route('/thirdfi-webhooks', methods=['POST']), specify https://example.com/thirdfi-webhooks as the endpoint URL.

Add a webhook endpoint

  1. Open the Webhooks page.
  2. Click Webhook tab.
  3. Click Add Endpoint.
  4. Add your webhook endpoint's HTTPS URL in Endpoint URL.
  5. If you want to test the webhook in sandbox environment, tick the Sandbox to set it on sandbox environment.
  6. Click Save to create the endpoint in Securo.

Manage webhook endpoints

You can update or delete existing webhook endpoints in the Dashboard's Webhooks settings page. You also have the option of disabling a webhook endpoint temporarily. ThirdFi does not retry any notifications that are generated while the endpoint is disabled.