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": "77495d71-5242-439f-bb7b-f77dbc8bc002",
  "event": "shipment.created",
  "created": "2026-06-12T18:11:58.925Z",
  "data": {
    "shipmentId": "ci332doamyk00000000000000",
    "merchantReference": "PHR-5090",
    "carrier": "indrive",
    "carrierName": "inDrive",
    "providerShipmentId": "INDRIVE-TK85FUS",
    "trackingUrl": "https://track.indrive.example.com/j79nhdu0",
    "costKobo": 129757,
    "deliveryEta": "2026-06-12T18:48:58.925Z",
    "pickupAddress": "Adetokunbo Ademola, V.I.",
    "dropoffAddress": "Adeola Odeku, V.I., Lagos",
    "failoverAttempts": [
      {
        "carrier": "uber",
        "error": "No riders available in pickup zone right now.",
        "attemptedAt": "2026-06-12T18:11:58.925Z"
      },
      {
        "carrier": "indrive",
        "error": null,
        "attemptedAt": "2026-06-12T18:12:02.925Z"
      }
    ],
    "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.