Skip to main content
stress-0922 Docs
current

Search documentation

Type to search this documentation.

Shipment status changed

Webhook callback sent for shipmentStatusChanged.

POST shipmentStatusChanged

Webhook callback sent for shipmentStatusChanged.

This is an outbound webhook callback initiated by the API. Your endpoint receives this request; it is not a request path exposed by the API server.

Request body

Content type: application/json

{
  "created_at": "2026-06-09T00:00:00Z",
  "data": {
    "event": {
      "id": "evt_00000000000000000001",
      "location": {
        "city": "Samplehaven",
        "country": "ZZ"
      },
      "message": "Parcel scanned at synthetic sorting hub",
      "object": "tracking_event",
      "occurred_at": "2026-09-05T05:40:00Z",
      "shipment_id": "shp_00000000000000000001",
      "status": "canceled"
    },
    "shipment": {
      "created_at": "2026-09-04T08:15:30Z",
      "delivery_instructions": "string",
      "id": "shp_00000000000000000001",
      "metadata": {
        "additionalProp1": "string"
      },
      "object": "shipment",
      "parcels": [
        {
          "contents": [
            {
              "customs_code": "610910",
              "description": "Synthetic cotton shirt",
              "quantity": 2,
              "unit_value": {
                "amount": "12.50",
                "currency": "XTS"
              }
            }
          ],
          "height_cm": 12,
          "length_cm": 30.5,
          "weight_grams": 1750,
          "width_cm": 20
        }
      ],
      "recipient": {
        "city": "Exampleton",
        "company": "Northstar Supplies",
        "country": "ZZ",
        "line1": "14 Fictional Quay",
        "line2": "Unit 7",
        "name": "Rowan Example",
        "phone": "+00000000000",
        "postal_code": "EX4 2PL",
        "region": "Test Province"
      },
      "reference": "synthetic-order-1042",
      "sender": {
        "city": "Exampleton",
        "company": "Northstar Supplies",
        "country": "ZZ",
        "line1": "14 Fictional Quay",
        "line2": "Unit 7",
        "name": "Rowan Example",
        "phone": "+00000000000",
        "postal_code": "EX4 2PL",
        "region": "Test Province"
      },
      "service": "economy",
      "status": "canceled",
      "tracking_number": "PE-000000000001",
      "updated_at": "2026-09-04T08:16:12Z"
    }
  },
  "id": "wh_evt_0000000000000001",
  "type": "shipment.status_changed"
}

Responses

204

Event accepted

Documentation menu