The ecom payments webhook is an HTTP-based callback mechanism designed to enable lightweight, event-driven communication between the ecom payments system and merchants' applications via APIs. By utilizing webhooks, merchants can seamlessly receive real-time notifications and data from ecom payments, allowing for streamlined automation of payment-related workflows.
- Event-Driven Communication: Webhooks notify merchants’ systems instantly about key payment events, such as successful transactions, refunds, or failures.
- Efficient Data Transfer: Transmit only essential data, ensuring minimal resource usage and optimized performance.
- Real-Time Processing: Immediate delivery of event notifications enables merchants to respond promptly, such as updating order statuses or notifying customers.
- Automation Integration: Webhooks can trigger automated workflows, making them ideal for use in DevOps and GitOps environments.
-
SSL
SSL is required. Ensure that your server is configured to support HTTPS, with a valid server certificate.
Usage
Using your Ecom account. dashboard -> api credentials tab . you can set your options like the screen below
Webhook standard payload
this is an example of the webhook payload you will receive from Ecom
{
"timestamp": "2025-02-04T12:12:12Z",
"eventType": "TRANSACTION_STATUS_CHANGED" | "REFUND_STATUS_CHANGED" | "PAYOUT_RELEASED" | "RECURRING_STATUS_CHANGED" ,
"data": Transaction Data Model | Refund Data Model | Payout Data Model| Recurring Data Model
};Webhook Data Models