Skip to main content

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:

FieldData TypeDescription
statusStringStatus of the webhook delivery (e.g., 'SUCCESS')
messageStringDescriptive message about the operation
shipmentDetailsObjectContains details of the shipment
shipmentDetails.currentStatusStringCurrent status of the shipment (e.g., 'DELIVERED')
shipmentDetails.current_locationStringLatest known location of the shipment
shipmentDetails.current_status_remarkStringRemarks about the current status
shipmentDetails.expected_date_of_deliveryStringEstimated delivery date (format: DD-MMM-YYYY HH:mm:ss)
shipmentDetails.shipping_providerStringName of the carrier handling the shipment
shipmentDetails.statusDateStringStatus timestamp (format: DD-MMM-YYYY HH:mm:ss)
shipmentDetails.waybillStringShipment'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 OK HTTP status to acknowledge successful receipt.
  • Any other status code may trigger retries.