Setting Up and Using Webhooks

You can configure webhooks to automatically receive updates from our system after specific API requests are completed. Here's how to set it up:

Webhook Configuration Steps

1. Enter Webhook Name

   Give your webhook a name so you can identify it later.

2. Enter Webhook URL

   Provide the endpoint (URL) where you want to receive webhook responses.

3. Enter Description (Optional)

   Add a short description for your reference. This is optional but helpful for organization.

4. Enter Secret Code

   The secret code will be used to generate a hash of the entire webhook message body (the body field in the webhook response).

   • This hash will be included in the webhook response under the hash field.
   • On your side, you can verify the message by validating the hash with the secret.
   • This ensures the message is authentic and has not been tampered with.

5. Enable or Disable Triggers

   Webhooks can be configured with triggers.

   • Triggers allow you to control which API endpoints should send webhook responses.
   • You can enable or disable webhook updates for individual endpoints.

---

Webhook Flow

Once an API request is completed:

• The system checks if webhook delivery is enabled for that specific API.
• If enabled, a response is sent to your configured webhook URL.
• The response includes both the result and the verification hash.

This mechanism ensures real-time, secure communication between your system and ours.