Hey Couriers
    Hey Couriers
    • Hey Couriers API Documentation
    • Hey Courier
      • APIs for Packages
        • APIs for Archive Packages
          • Restore The Package
          • Archive The Package
          • Get The Archived Package List
        • Get The Package List
        • Create Package
        • Retrieve Particular Package
        • Bulk Package Upload Using Excel
        • Bulk Package Upload Using CSV
        • Download CSV Of Selected Packages
        • Download CSV Of Company Packages of Given Status
        • Get The POD Report of Package
        • Get The POD Report for Multiple Package
        • Update Package
      • Company Pickup Package
        • Company Pickup Package Bulk Upload
        • Company Pickup Package Excel Upload
        • Company Pickup Package Create
        • Company Pickup Package Update
        • Login Company Pickup Package List
    • Package Tracking (To Track Package)
      GET
    • Multiple Package Tracking (To Track Package)
      PATCH
    • Package Status Update By Webhook
      POST
    • Multi Label Printing By Webhook
      POST
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag

      Package Status Update By Webhook

      Developing
      POST
      {{base_url}}add-package-by-webhook/update-track-event/
      This API endpoint is used to update the status of packages in the system through a webhook. It enables automated communication between external courier systems or third-party integrations and our tracking system, ensuring that parcel statuses are updated in real time based on delivery events.
      The API supports uploading a Proof of Delivery (POD) file along with structured tracking data via form-data. Each webhook request must include the parcel’s unique article ID and its corresponding status details.
      Typical Use Cases
      Automatically update parcel statuses (e.g., Received in Depo, In Transit, Delivered, etc.) from third-party logistics systems.
      Sync real-time delivery progress across integrated courier platforms.
      Upload Proof of Delivery (POD) files when a parcel is delivered.
      Request Parameters
      pod_file (file, optional) – Proof of Delivery document or related file.
      form_data (string, required) – JSON string containing the parcel ID and tracking event details.
      Example:
      {
      "articleId": "ARP1000052447",
      "track_status": "Delivered",
      "track_datetime": "2025-10-08T10:15:00Z",
      "remarks": "Delivered successfully"
      }
      Response
      HTTP 200 – Success
      Returns a JSON response confirming the package status has been successfully updated.
      Parcel Status Descriptions supports in our system
      Not Scanned – This is the default status assigned to every new parcel added to the system. It indicates that the parcel has not yet been scanned at the depot.
      Received in Depo – Once the parcel is scanned at the depot, its status updates to Received in Depot, confirming that it has arrived and been logged by the depot team.
      Loaded by Driver – This status occurs when the driver scans the parcel while loading it into the delivery vehicle for dispatch.
      In Transit – After the route is created and the driver leaves the depot for delivery, the parcel status changes to In Transit, meaning it is currently out for delivery.
      Delivered – When the driver successfully delivers the parcel to the customer, he performs the Deliver action in the system, which updates the status to Delivered.
      Failed Delivery – If the delivery attempt is unsuccessful (for example, the customer is not available or the address is incorrect), the driver performs the Failed Delivery action in the system, updating the status accordingly.
      RTS- Return to Sender – This status is used when a parcel is returned to the sender due to reasons such as product damage, incorrect details, or other issues requiring return.
      RD- Return to depo – When a failed delivery parcel is brought back to the depot, the depot manager scans it upon receipt, updating the status to Return to Depo.

      Request

      Header Params

      Body Params multipart/form-data

      Request Code Samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST '{{base_url}}add-package-by-webhook/update-track-event/' \
--header 'X-WebHook-Secret: EZYJZesR3E82HcwFEbMjm67qKq1HYpI4' \
--form 'pod_file=@""' \
--form 'form_data="[    {        \"articleId\": \"ARP1000052447\",        \"trackingEvents\": [            {                \"trackEventDateOccurred\": \"2021-07-28 10:14:00\",                \"latitude\": \"-33.7719461\",                \"longitude\": \"150.917664\",                \"status\": \"Received in Depo\"            }        ]    }]"'

      Responses

      🟢200Success
      application/json
      Body

      Example
      {
    "success": true,
    "message": "Package Status Updated Successfully."
}
      Modified at 2025-11-26 09:46:34
      Previous
      Multiple Package Tracking (To Track Package)
      Next
      Multi Label Printing By Webhook
      Built with