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": "430a8a17-b2b6-4ec4-b993-73dc9c38930c",
  "event": "shipment.created",
  "created": "2026-10-25T18:11:03.716Z",
  "data": {
    "shipmentId": "c6am1c0y2xlt0000000000000",
    "merchantReference": "PHR-2218",
    "carrier": "chowdeck",
    "carrierName": "inDrive",
    "providerShipmentId": "CHOWDECK-V0LJQ8B",
    "trackingUrl": "https://track.chowdeck.example.com/mnal0gis",
    "costKobo": 179710,
    "deliveryEta": "2026-10-25T19:02:03.716Z",
    "pickupAddress": "Allen Avenue, Ikeja",
    "dropoffAddress": "Aminu Kano Crescent, Wuse 2, Abuja",
    "failoverAttempts": [
      {
        "carrier": "chowdeck",
        "error": null,
        "attemptedAt": "2026-10-25T18:11:03.716Z"
      }
    ],
    "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.