Notification event [Useful for selected webhooks]
In case you want to receive webhooks only for specific events from Clickpost, Clickpost provides functionality for the same.
If you opt for this service (Selected Event Webhooks), we add the "notification_event_id" key in the webhook payload. This will inform you of the current status of the shipment.
Notification Event ID
| Notification Event ID | Description | Clickpost Status Code |
|---|---|---|
| 1 | Out For Pickup | 25 |
| 2 | Shipped | [4, 5, 18, 19, 20] |
| 3 | Out For Delivery | 6 |
| 4 | Failed Delivery | [7, 9] |
| 5 | Delivered | 8 |
| 86 | RTO-Requested | [11, 12] |
| 6 | RTO | [13, 15, 21, 26, 27] |
| 10 | Order Cancelled | 10 |
| 12 | RTO-Delivered | 14 |
| 13 | Reached destination hub | 1004 |
| 14 | Exchange Pickup | [30, 31] |
| 15 | Exchange Delivered | [32] |
| 16 | Pickup Failed | [3] |
| 17 | Shipment Stuck | |
| 18 | SLA breached | |
| 19 | Lost | 16 |
| 20 | Damaged | 17 |
| 80 | Expired | 23 |
| 28 | Shipped from Origin hub | 1006 |
Notification Event: 6 defines that the shipment has been marked as RTO-In-transit by the carrier and in general is considered a flag to initiate refunds.
Following notification_event_id are helpful for customers using Clickpost's managed returns/exchange service, which accepts return requests from the end user:
| Value | Description |
|---|---|
| 9 | AWB registered: As soon as an AWB is generated in Clickpost |
| 11 | Return request placed: As soon as a return request is placed by the end user using Clickpost’s return UI |
| 22 | Return request approved |
| 23 | Return request rejected |
| 30 | Exchange request placed: as soon as an exchange request is placed by the end user using Clickpost's return/exchange UI |
| 29 | Exchange request approved |
| 31 | Exchange request Rejected |
HLD Specific Notification Event IDs
| Notification Event ID | Notification Event Description |
|---|---|
| 92 | RiderAllocationFailed |
| 93 | RiderAllocated |
| 94 | ReachedPickupLocation |
| 95 | ReachedDropLocation |
| 139 | RiderEnteredDropLocationGeofence |
HLD Reallocation Specific Notification Event IDs
For sample webhook payloads of these events, refer to Fetch Reallocation Order Details via Webhook
| Notification Event ID | Notification Event Description |
|---|---|
| 115 | SHIPMENT_CREATION_SUCCESSFUL |
| 116 | SHIPMENT_CREATION_FAILED |
| 117 | CARRIER_ALLOCATED |
| 118 | CARRIER_ALLOCATED_PROVISIONALLY |
| 134 | REALLOCATION_ABORTED |
| 146 | REALLOCATION_PAUSED |
| 147 | REALLOCATION_UNEXPECTEDLY_ABORTED |
Terminal Notification Event IDs
| Notification Event ID | Notification Event Description |
|---|---|
| 5 | Delivered |
| 12 | RTO Delivered |
| 19 | Lost |
| 20 | Damaged |
| 10 | Cancelled |
**Important note:
- notification_event_ids and clickpost_status_codes are different codes. If you are using subscribing for selected event webhooks, you should apply logic on notification_event_id.
- In case you subscribe for all status event webhooks, you should apply logic on clickpost_status_code : https://docs.clickpost.ai/docs/tracking-status-codes
Updated 13 days ago
Did this page help you?
