Sign in
Events/Logistics
shipment.created

Shipment created

A new shipment was dispatched (order-bound or external).

When this fires

Fires whenever the underlying state change happens on the platform.

Sample payload

This is the exact envelope shape we POST to your endpoint — outer wrapper plus the per-event data payload. Field values are randomised on each render so you see the general shape, not a fixed example.

json
{
  "id": "70c9343a-7ab0-4152-a673-dbb36881ca37",
  "event": "shipment.created",
  "created": "2026-07-29T11:24:55.726Z",
  "data": {
    "shipmentId": "cc1b326toqvk0000000000000",
    "merchantReference": "PHR-7488",
    "carrier": "fez",
    "carrierName": "Fez Delivery",
    "providerShipmentId": "FEZ-G9970AQ",
    "trackingUrl": "https://track.fez.example.com/b0c2cf7z",
    "costKobo": 250488,
    "deliveryEta": "2026-07-29T12:10:55.726Z",
    "pickupAddress": "Toyin Street, Ikeja",
    "dropoffAddress": "Admiralty Way, Lekki, Lagos",
    "failoverAttempts": [
      {
        "carrier": "fez",
        "error": null,
        "attemptedAt": "2026-07-29T11:24:55.726Z"
      }
    ],
    "excluded": [
      {
        "carrier": "indrive",
        "carrierName": "inDrive",
        "reasons": [
          {
            "kind": "max_weight",
            "limitKg": 25,
            "parcelKg": 32
          }
        ]
      }
    ]
  }
}

Use cases

  • Trigger any downstream automation that cares about this state change.
  • Mirror the event into your data warehouse for analytics.
  • Notify a human channel for high-signal events.

Subscribe in the dashboard

To start receiving this event, add it to a webhook's subscription list in Developers → Webhooks. Wildcard subscriptions ( shipment.*) work too — see the webhooks guide for the matching rules.