Webhook Setup
Effective Date: 01 July 2025
Webhooks play a critical role in ensuring real-time communication between the platform and your systems. The webhook infrastructure is designed to help you receive instant updates on transaction statuses, payout responses, and other critical events. This guide outlines how to configure, secure, and manage webhooks for seamless integration.
Purpose of Webhooks
Webhooks are user-defined HTTP callbacks that notify your system whenever specific events occur on the platform. Instead of polling for updates, your application gets real-time alerts, reducing latency and improving efficiency.
Benefits of Using Webhooks
Receive real-time transaction updates
Improve operational workflows by automating status handling
Reduce system load caused by repeated API polling
Enhance transparency and reporting capabilities
Events Supported by Webhooks
Webhook delivery is supported for the following key events:
Pay-in success or failure notifications
Payout transaction updates
Refund status alerts
API request exceptions or errors
Balance threshold warnings (on request)
Webhook Configuration Process
Endpoint Registration
Clients must provide a valid and secure HTTPS URL to receive webhook payloads. This endpoint should be reachable and configured to accept POST requests.
Authentication Setup
Each webhook call is signed with a secure key to ensure authenticity. Clients must validate this signature to prevent unauthorized access.
Payload Structure
Webhook payloads include all relevant event data such as transaction ID, status, timestamp, and response codes. A consistent format ensures easy parsing and integration.
Testing Environment
Before production use, clients are required to test their webhook endpoints in the sandbox environment. Test notifications can be sent to verify handling and security logic.
Retry Mechanism
In case the webhook delivery fails due to client-side issues (such as timeouts or server errors), delivery is automatically retried based on a predefined schedule.
Security Recommendations
Use HTTPS to secure all webhook endpoints
Validate request signatures using the shared secret
Implement logging for received webhooks
Set up IP whitelisting if required for additional control
Handle duplicate webhook payloads idempotently
Response Expectations
Upon receiving a webhook, your server must return a 200 OK HTTP response within a short time frame. Failure to do so will trigger retries. Avoid lengthy processes in the webhook handler; instead, queue events for background processing.
Monitoring and Troubleshooting
Monitoring tools are provided to track webhook delivery status and logs. Any failures or delays can be reviewed through the dashboard or technical support team.
Updates and Version Control
Webhook formats may be updated as the platform evolves. Clients will receive advance notifications about format or endpoint changes. Maintaining backward compatibility is a priority in all updates.
Support for Webhook Integration
Onboarding and technical support teams assist clients throughout the webhook setup and maintenance process. From endpoint testing to debugging delivery issues, a reliable integration experience is ensured.
Contact Us
Level 5, ITPL Main Rd, Devasandra Industrial,
Bengaluru, Karnataka 560048
Email: cbdo@dotpe.co
Phone: +447563009191