Webhooks
Topics
Subscribe your endpoint to any combination of these topics. Most retailers start with the Order Lifecycle group.
Order Lifecycle
Top-level order state changes and milestones.
| Topic | Description |
|---|---|
| order_created | Order entered Grasshopper |
| order_status_changed | Top-level order status moved (see Order statuses reference) |
| order_estimated_arrival_changed | ETA window updated |
| order_complete_stop | Order reached a terminal state (Delivered / Failed / Damaged) |
| order_returned | Order moved into return flow |
Scheduling
Delivery date and appointment changes.
| Topic | Description |
|---|---|
| delivery_changed | Scheduled date or window updated |
| delivery_confirmed | Customer confirmed the delivery window |
| appointment_requested | Customer or system requested an appointment change |
| appointment_failed | Could not schedule within available windows |
Items
Granular per-item events. Useful when items diverge.
| Topic | Description |
|---|---|
| item_status_changed | Per-item status update |
| item_damaged | Item flagged as damaged |
| item_short | Item missing or shorted |
| item_refused | Customer refused this item at delivery |
Notes
Operational and customer-facing notes.
| Topic | Description |
|---|---|
| note_added | Operational note added (dispatch, driver, customer service) |
| customer_note_added | Customer-visible note added |
Assets
Photos, signatures, and POD documents.
| Topic | Description |
|---|---|
| asset_added | New asset attached (POD, signature, damage photo) |
| pod_received | Electronic POD received and processed |
Tracking Events
Granular tracking event subscriptions for advanced integrations.
| Topic | Description |
|---|---|
| tracking_event_added | Any new tracking event written to order.tracking[] |
Recommended starter set
For most retail integrations, subscribe to these and you'll cover 95% of real-time tracking needs:
order_createdorder_status_changeddelivery_changedorder_estimated_arrival_changedorder_complete_stopasset_added(for POD delivery)