Description

We offer the ability to receive real-time shipment status updates through a webhook.
A complete list of all available status updates, including their descriptions, is provided in this Google Sheets.

Setting Up the Webhook

To start receiving real-time status updates, please follow these steps:

Set up an HTTPS endpoint / webhook that can accept POST requests.
Send the following information to api@cargoboard.com:
- URL of your endpoint
- (Optional) Authentication details, if required
- Your customer number or a clear reference to your customer account (e.g., the registered email address)
Once we receive your information, we will configure the webhook and start sending all generated status updates in real-time to your provided endpoint.

Notes

Status updates are sent immediately after they are generated.
You will find a detailed description of all status updates in the attached document.

Payload

{
  "order": {
    "reference": "string", //our shipment reference
    "id": "string", //our shipment id
    "customerId": "string",
    "customerOrderCode": "string" //your shipment reference
  },
  "event": {
    "id": "string", 
    "statusCode": "string", //status code of tracking event
    "label": "string", //label of tracking event / description
    "originatedAt": "2025-05-02T12:00:00Z",
    "emittedBy": "string",
    "nameOfSigner": "string", 
    "message": "string",
    "estimatedCollectionAtFrom": "2025-05-03T08:00:00Z",
    "estimatedCollectionAtUntil": "2025-05-03T12:00:00Z",
    "estimatedDeliveryAtFrom": "2025-05-05T08:00:00Z",
    "estimatedDeliveryAtUntil": "2025-05-05T18:00:00Z"
  },
  "environment": "production"
}