Skip to main content

Pre-requisites

  • You have an active Conduit account with API access
  • You have API credentials (API Key and Secret)
  • You have understood our Webhooks Developer Section
In this guide, we will learn how to create your first webhook. A webhook is a URL that Conduit will call when certain events occur. For example, when a transaction is created, Conduit will call the webhook URL with the transaction details.

Registering Webhook Endpoint

To start receiving real-time updates, you must register your webhook endpoint with Conduit. You can do this by sending a POST request to the /webhooks API endpoint with your webhook details.

Request Example

Request Parameters: Example Response
** Response Field description**

Retrieve Your Webhook Secret

Before you can verify incoming webhook requests, you need the secret associated with your webhook. This secret is used to validate the authenticity of each request from Conduit, protecting your system from unauthorized or forged events. To find your webhook secret:
  1. Log into your Conduit Dashboard
  2. Navigate to the Webhooks tab.
  3. Locate the webhook you created and click on it
  4. Click on it to view the Key Secret field this what you use in your signature verification process.

Verifying Webhook Requests

For security,** every webhook request from Conduit must be verified before processing**. Use the secret you retrieved above to validate the HMAC SHA-256 signature included in each request header. The following NodeJS handler middleware demonstrates how to implement a secure webhook receiver that:
  • Extracts the signature headers from the incoming request.
  • Recreates the HMAC signature using your webhook secret for verification.

Structure of Webhook Payload

Each webhook you receive from Conduit follows a consistent structure.
Field descriptions:

Payload Examples

For a comprehensive list of webhook events and detailed payload examples for all resource types (including Transactions, Customers, and Counterparties), please refer to our Webhooks Reference. For list of all the events that you can subscribe to, please check our Webhooks Supported Events Developer Section.

What’s next?

Support

Reach out to our support team to get help and share your feedback.