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": "14354966-7f9e-4004-977c-4e9e9f9f1cf1",
  "event": "shipment.created",
  "created": "2026-07-29T17:36:10.065Z",
  "data": {
    "shipmentId": "cht1hwo4w94q0000000000000",
    "merchantReference": "PHR-7918",
    "carrier": "fez",
    "carrierName": "Fez Delivery",
    "providerShipmentId": "FEZ-JMY8T59",
    "trackingUrl": "https://track.fez.example.com/gk90hb9u",
    "costKobo": 216066,
    "deliveryEta": "2026-07-29T19:05:10.065Z",
    "pickupAddress": "Awolowo Road, Ikoyi",
    "dropoffAddress": "Admiralty Way, Lekki, Lagos",
    "failoverAttempts": [
      {
        "carrier": "fez",
        "error": null,
        "attemptedAt": "2026-07-29T17:36:10.065Z"
      }
    ],
    "excluded": []
  }
}

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.