Webhooks
Topics
Subscribe your endpoint to any combination of these topics. Most retailers start with the Order Lifecycle group; deeper integrations layer on Items, Tracking, Manifests, and Inventory as their workflow grows.
Order Lifecycle
Order creation, state transitions, and terminal milestones. The backbone of every webhook integration.
| Topic | Description |
|---|---|
| order_created | Order entered Grasshopper |
| ack_async_order_creation | Async order-creation request was accepted and queued |
| async_order_creation_completed | Async order creation finished; the order ID is now available |
| order_updated | Top-level order fields changed |
| order_status_changed | Top-level order status moved (see Order statuses reference) |
| order_type_changed | Order type was reclassified |
| order_estimated_arrival_changed | ETA window updated |
| expected_arrival_changed | Expected arrival date changed (legacy alias used by some integrations) |
| order_complete_stop | Order reached a terminal delivery stop (Delivered / Failed / Damaged) |
| order_complete_stop_pickup | Order reached a terminal pickup stop |
| order_returned | Order moved into the return flow |
| order_disposed | Order was disposed (write-off or destruction) |
| order_on_hold | Order placed on hold |
| order_remove_hold | Hold removed from order |
| cancel_order | Order was canceled |
| order_failed_deluxe | Order entered the "deluxe" failed state and needs intervention |
| order_broadcast_delivery_time_frame | Broadcast of a delivery time-frame to subscribers |
| order_split_request | Request to split an order into sub-orders |
| create_return_order | A return-order create request flowed through the bus |
| billable_order_created | Billable order record was created |
| inventory_billable_order_created | Billable order created against an inventory item |
| free_delivery | Order marked as free delivery |
Scheduling
Delivery date, window, and appointment changes.
| Topic | Description |
|---|---|
| delivery_changed | Scheduled delivery date or window updated |
| order_scheduled_for_delivery | Order placed on a delivery schedule |
| schedule_request | Request to schedule a delivery date |
| cancel_delivery | Scheduled delivery canceled |
Pickups
Pickup scheduling, attempts, and last-mile terminal reservations.
| Topic | Description |
|---|---|
| pickup_date_schedule_changed | Pickup date or window changed |
| order_pickup_failed | Pickup attempt failed |
| first_available_date_recorded | Earliest date the order became available for pickup |
Routing & Arrival
On-site arrival events and order reassignment.
| Topic | Description |
|---|---|
| arrive_on_site | Driver or agent arrived on site |
Items
Per-item events on an order. Useful when items diverge from the order-level state.
| Topic | Description |
|---|---|
| item_added | Item added to order |
| item_removed | Item removed from order |
| item_updated | Item attributes updated |
| item_status_changed | Per-item status update |
| item_damaged | Item flagged as damaged |
| item_shortage | Item missing or shorted |
| items_moved | Items moved between orders |
| item_warehouse_location_changed | Item's warehouse location changed |
| item_mark_for_dock_search | Item flagged for dock search |
| update_line_item_freight_info | Freight information was updated on a line item |
Tracking
Tracking-record updates and tracking-ID publication.
| Topic | Description |
|---|---|
| tracking_changed | Any change to the order's tracking record |
Assets
POD documents, signatures, photos, and other order attachments.
| Topic | Description |
|---|---|
| asset_added | New asset attached (POD, signature, damage photo) |
| asset_removed | Asset removed from order |
Notes
Operational and delivery-time notes attached to orders.
| Topic | Description |
|---|---|
| notes_added | Operational note added (dispatch, driver, customer service) |
| notes_updated | Operational note was edited |
| delivery_notes_added | Delivery-specific note added |
Charges
Accessorial, assembly, repair, and packaging charges added to or removed from an order.
| Topic | Description |
|---|---|
| assembly_charge_added | Assembly charge added to order |
| repair_charge_added | Repair charge added to order |
| repair_inventory_item_charge_added | Repair charge added against an inventory item |
| repair_charge_rejected | Repair charge was rejected |
| repair_inventory_item_charge_rejected | Inventory-item repair charge was rejected |
| accessorial_charge_added | Accessorial charge added |
| accessorial_charge_removed | Accessorial charge removed |
| packaging_charge_added | Packaging charge added |
Customer & Surveys
Customer contact changes, contact requests, and survey responses.
| Topic | Description |
|---|---|
| customer_information_changed | Customer contact information changed |
| survey_response_received | Customer survey response received |
| third_man_count_updated | Third-man crew count updated for delivery |
Payments
Payment status, terms, and verification.
| Topic | Description |
|---|---|
| payment_status_changed | Payment status moved (e.g. authorized → captured) |
| payment_terms_changed | Payment terms updated |
| verify_order_payment | Order payment verification was performed |
Service & Linkage
Service-level changes and order linkage between related orders.
| Topic | Description |
|---|---|
| service_level_changed | Order service level changed (see Service levels reference) |
| order_linkage_added | Order linked to another order |
| order_linkage_removed | Order linkage removed |
Claims
Damage and loss claim lifecycle.
| Topic | Description |
|---|---|
| claim_created | Claim filed |
| claim_status_changed | Claim status changed |
| claim_closed | Claim closed |
Inventory & WMS
Inventory item lifecycle, warehouse moves, and repair completion.
| Topic | Description |
|---|---|
| inventory_items_created | Inventory item(s) created |
| inventory_items_received | Inventory received at warehouse |
| inventory_item_assigned_to_order | Inventory item assigned to an order |
| inventory_items_assigned_to_inventory | Items reassigned back to the inventory pool |
| inventory_item_removed | Inventory item removed from a container or order |
| inventory_item_updated | Inventory item updated |
| inventory_item_deleted | Inventory item deleted |
| inventory_item_note_added | Note added to an inventory item |
| inventory_item_tracking_created | Tracking record created for an inventory item |
| inventory_item_location_changed | Inventory item location changed |
| inventory_item_failed_deluxe | Inventory item entered the "deluxe" failed state |
| inventory_item_repair_completed | Inventory item repair completed |
Recommended starter set
For most retail integrations, subscribing to these seven topics covers the vast majority of real-time tracking needs:
order_createdorder_status_changeddelivery_changedorder_estimated_arrival_changedorder_complete_stoptracking_changedasset_added(for POD delivery)