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": "cdf0f15c-c6da-423a-9eac-1cb68de4ae63",
  "event": "shipment.created",
  "created": "2026-09-11T01:03:46.289Z",
  "data": {
    "shipmentId": "cxevpgp5mvfc0000000000000",
    "merchantReference": "PHR-2628",
    "carrier": "fez",
    "carrierName": "Fez Delivery",
    "providerShipmentId": "FEZ-A075TEM",
    "trackingUrl": "https://track.fez.example.com/lsxqr5yy",
    "costKobo": 368360,
    "deliveryEta": "2026-09-11T02:03:46.289Z",
    "pickupAddress": "Bode Thomas, Surulere",
    "dropoffAddress": "Gana Street, Maitama, Abuja",
    "failoverAttempts": [
      {
        "carrier": "fez",
        "error": null,
        "attemptedAt": "2026-09-11T01:03:46.289Z"
      }
    ],
    "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.