Tracking Webhook
The Tracking Webhook notifies your system with the latest shipment tracking data for events occurring in Openleaf.
Your endpoint will receive a POST request with the body described below whenever a relevant tracking event occurs.
Webhook POST Body
The body of the webhook request will be JSON and have the following structure:
| Field | Data Type | Description |
|---|---|---|
| status | String | Status of the webhook delivery (e.g., 'SUCCESS') |
| message | String | Descriptive message about the operation |
| shipmentDetails | Object | Contains details of the shipment |
| shipmentDetails.currentStatus | String | Current status of the shipment (e.g., 'DELIVERED') |
| shipmentDetails.current_location | String | Latest known location of the shipment |
| shipmentDetails.current_status_remark | String | Remarks about the current status |
| shipmentDetails.expected_date_of_delivery | String | Estimated delivery date (format: DD-MMM-YYYY HH:mm:ss) |
| shipmentDetails.shipping_provider | String | Name of the carrier handling the shipment |
| shipmentDetails.statusDate | String | Status timestamp (format: DD-MMM-YYYY HH:mm:ss) |
| shipmentDetails.waybill | String | Shipment's waybill (AWB) number |
Request Example
{
"status": "SUCCESS",
"message": "Shipment tracking data returned successfully",
"shipmentDetails": {
"currentStatus": "DELIVERED",
"current_location": "Thane",
"current_status_remark": "SHIPMENT DELIVERED ",
"expected_date_of_delivery": "13-Jan-2025 00:00:00",
"shipping_provider": "Delhivery",
"statusDate": "12-Aug-2025 15:48:00",
"waybill": "37204668339"
}
}
Responding to the Webhook
- Your endpoint should return a
200 OKHTTP status to acknowledge successful receipt. - Any other status code may trigger retries.