Overview
Webhooks is a communication tool that sends real-time notifications to the receiver by obtaining events from the source application. It provides a streamlined way to manage subscriptions and event notifications.
Webhooks enable users to create technical subscriptions for specific events within the source application. When these events occur, the webhooks send an HTTP callback to a designated endpoint, notifying the receiver.
Event - Overview
Webhooks generate event objects containing event data (payload) whenever an event occurs. These event objects are automatically sent in POST requests to the registered webhook endpoint. Upon receiving the event, the endpoint notifies the recipient of the specific event.
Event Object
The event object sent to the webhook endpoint contains payload parameters that include details or changes related to the specific event.
List of Events
Below table contains the list of available events from the source application with respective descriptions.
Event | Description |
---|---|
New Account | A new account is created |
Update Account | Status of an account is updated |
New Transaction | A new transaction is created |
Update Transaction | Status of a transaction is updated |
Example event payload
{
"source": "PL",
"eventId": "EVT1358241",
"eventName": "Account.NEW",
"payload": {
"id": "1356001",
"name": "General Account",
"number": "200851030137182",
"createdDate": "2023-11-06T10:09:44.574Z",
"updatedDate": "2023-11-06T10:09:44.574Z",
"balance": 0,
"customerID": "100000000018002",
"customerName": "Ravi Test18",
"accountType": "WALLET",
"currency": "USD",
"currencyCode": "048",
"status": "ACTIVE",
"program": "PL",
"accountLevel": "WPS"
},
"signature": "{{Signature}}"
}