Scan push/Webhook Requirement document
VERSION NO. : 1.0 VERSION DATE : 01/09/2022
CREATION DATE AUTHOR(s) APPROVER(s)
29/08/2022 Vikalp Singh Anil Kumar, Sahil Anand
Introduction
This document is to capture the Webhook/Scan push requirements of the client.
Client need to fill this document with the below details and shared is back to the Delhivery team
and based on these details only Delhivery tech team will enable the webhook.
Based on the development effort and sprint planning, Delhivery will share the go live date of the
webhook.
Here client need to fill only the yellow highlighted fields along with their tech escalation matrix.
Account Name:
Dev account name:
For RKWORLDWIDE6 B2BC - 271678dc61297db3f33031f5975546a4098ab333
For RKWORLDWIDE8 B2BC - 1927142d01989f1f10cb1caeb0b76fd95e467c40
Prods account name: RKWORLDWIDE6 B2BC , RKWORLDWIDE8 B2BC
Webhook API details:
Dev API endpoint: [Link]
Header: {
"Authorization": "Bearer <your_dev_api_token>",
"Content-Type": "application/json",
"Accept": "application/json"
}
Prod API endpoint: [Link]
Disclaimer- Delhivery don’t share any customer PII details in the scan push. This includes customer phone,
address,name and address
Header: {
"Authorization": "Bearer <your_prod_api_token>",
"Content-Type": "application/json",
"Accept": "application/json"
}
Allowed Method:
Only POST method is allowed
Webhook API Response time:
P99 Response Time: 100ms
Expected response time <=500 ms.
In case webhook api response time>500 ms, there will be a timeout at Delhivery end and client
might missed the shipment scans.
Payload:
Share the expected payload.
Default payload : Yes
"shipment_remark": "string",
"location": "string",
"count": "Number",
"lrnum": "string",
"mwn": "string",
"cl_uuid": "string",
"name": "string",
Disclaimer- Delhivery don’t share any customer PII details in the scan push. This includes customer phone,
address,name and address
"package_type": "Pre-paid",
"expected_delivery_date": "Number",
"promised_delivery_date": "Number",
"timestamp": "Number",
"status": "string",
"status_type": "string"
}
Custom payload: <Yes/No>- share the updated payload in case of “Yes”
Share the working curl in case of custom payload
Webhook API response:
200 Okay is the expected API response
IP’s to be whitelisted:
If client needs Delhivery IPs to be whitelisted to accept scan update from Delhivery. Use below
IPs
DEV IP’s:
[Link]
[Link]
[Link]
[Link]
[Link]
[Link]
[Link]
PROD IP’s:
[Link]
[Link]
[Link]
[Link]
Disclaimer- Delhivery don’t share any customer PII details in the scan push. This includes customer phone,
address,name and address
[Link]
[Link]
[Link]
[Link]
[Link]
Note: Delhivery not need to whitelist any IP to push to scans to client system
Required shipment scans:
All scans/Status needed - Yes share the required status where scan push is needed in
case of “No”, Need NSL where all scans are required
Escalation matrix:
Client need to share the tech escalation matrix here.
Level Contact Name Email id Phone Number
L1 Jyoti Naik rktech@[Link] 7795201935
L2 Kiran Heggere digital@[Link] 9590809394
L3 Ramakrishna md@[Link] 9448084952
Disclaimer- Delhivery don’t share any customer PII details in the scan push. This includes customer phone,
address,name and address
Internal for Delhivery Reference-
This will be filled by the Delhivery tech team internally
1. ADO details: <<add ADO here>>
2. Load Testing results:
<<add load testing results here>>
3. Volume of client on daily/monthly basis -
4. Need confirmation on release from client within 1-2 hour of the release if getting scans
fine our not
Disclaimer- Delhivery don’t share any customer PII details in the scan push. This includes customer phone,
address,name and address