shipment.createdShipment 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": "9f8fa140-255e-427c-b0b3-b45ccd3d4a29",
"event": "shipment.created",
"created": "2026-07-27T19:28:43.888Z",
"data": {
"shipmentId": "c2nn2gwzsaox0000000000000",
"merchantReference": "PHR-5460",
"carrier": "indrive",
"carrierName": "inDrive",
"providerShipmentId": "INDRIVE-0CNB68W",
"trackingUrl": "https://track.indrive.example.com/bi4ze5pk",
"costKobo": 182329,
"deliveryEta": "2026-07-27T20:12:43.888Z",
"pickupAddress": "Adetokunbo Ademola, V.I.",
"dropoffAddress": "Admiralty Way, Lekki, Lagos",
"failoverAttempts": [
{
"carrier": "indrive",
"error": null,
"attemptedAt": "2026-07-27T19:28:43.888Z"
}
],
"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.