Skip to main content

Webhooks

Introduction to Webhooks​

The Webhooks feature allows users to receive real-time notifications or data updates from our system by sending HTTP POST requests to a callback URL provided by the user. This documentation outlines the usage and response format of webhooks.

Overview​

Webhooks provide a mechanism for our system to push data to users' servers or applications in real-time. Instead of requiring users to poll our system for updates, we send HTTP POST requests to the callback URL specified by the user whenever a relevant event occurs. This enables users to receive timely notifications and react to changes immediately.

Usage​

To start receiving webhooks, users need to follow these steps:

  1. Provide Callback URL: Users must specify a callback URL where they want to receive webhook notifications. This URL should be accessible by our system and capable of receiving HTTP POST requests.

  2. Subscribe to Events: Users can choose to subscribe to specific events or types of notifications that they are interested in. This allows them to customize the types of data they receive via webhooks.

  3. Handle Webhook Requests: Once subscribed, users' servers or applications should be configured to handle incoming webhook requests. Upon receiving a webhook, users can process the data and perform any necessary actions based on the event received.

Response Format​

{
  "transaction_reference": "TX123456789",
  "phone_number": "+1234567890",
  "result_code": 200,
  "remarks": "Payment processed successfully",
  "third_party_trans_id": "3PTID123456789",
  "amount": 100.50,
  "transaction_date": "2024-03-05T14:25:30Z",
  "forward_url": "https://example.com/webhook/receiver",
  "bank_name": "Example Bank",
  "channel": "Online Banking",
  "order_id": "ORD123456789"
}
tip

Users should regularly monitor their webhook endpoints for incoming requests and handle them promptly.