Milestones

This page describes the different event types which will trigger a Event object to be sent to your registered Webhook Endpoints. Milestones designated with an asterisk are available upon request.

For all Estimated Transit Events, the data field of the Event webook payload is a Shipment Event Data object.

Name	Type	Description	Resource	Location
Schedule Confirmed	/shipment#schedule_confirmed	Estimated departure and arrival dates set for each specified location.	Shipment	None
Updated Estimated Time of Departure (ETD)*	/shipment_leg#updated_estimated_time_of_departure	Revised estimate of date when shipment will depart from specified location.	ShipmentLeg	departure location
Updated Estimated Time of Arrival (ETA)*	/shipment_leg#updated_estimated_time_of_arrival	Revised estimate of date when shipment will arrive at specified location.	ShipmentLeg	arrival location
Updated Estimated Out for Delivery*	/shipment_leg#updated_estimated_out_for_delivery	Revised estimate of date when shipment is out for delivery.	ShipmentLeg	departure location
Updated Route (This milestone is still under development)*	/shipment#updated_route	Updated route to final destination, such as changes to intermediary locations or ports.	Shipment	None
Updated Estimated Available for Pickup*	/shipment_container_leg#updated_estimated_available_for_pickup	Revised estimated of date when shipment will be ready for pickup at the port of delivery.	ContainerLeg	departure location

For all Actual Transit Events, the data field of the Event webhook payload is a Shipment Event Data object.

Name	Type	Description	Resource	Location
Actual Time of Arrival (ATA)	/shipment_leg#arrived	Shipment arrived at specified location.	ShipmentLeg	arrival location
Actual Time of Departure (ATD)	/shipment_leg#departed	Shipment departed from specified location.	ShipmentLeg	departure location
Actual Out for Delivery*	/shipment_leg#out_for_delivery	Shipment departed and is out for delivery	ShipmentLeg	departure location
Delivery Complete*	/shipment_leg#delivery_completed	Shipment delivery is complete	ShipmentLeg	destination location
Loaded on Board*	/ocean/shipment_container_leg#loaded_on_board	Shipment container loaded on vessel or rail.	ContainerLeg	where the container was loaded
Loaded on Truck*	/ocean/shipment_leg#loaded_on_truck	Cargo has been transloaded from shipment container to truck.	ShipmentLeg	where the cargo was loaded on the truck
Unloaded off Board*	/ocean/shipment_container_leg#unloaded_off_board	Shipment container discharged from vessel or rail.	ContainerLeg	where the container was unloaded
Arrived at Delivery Location	/shipment_leg#delivered	Part of a shipment delivered to final destination.	ShipmentLeg	delivery location
Delivered in Full	/shipment#delivered_in_full	Entire shipment delivered to final destination, e.g. multi-container shipments.	Shipment	shipment final destination

For all Administrative Events, the data field of the Event webhook payload is a Shipment Event Data object.

Name	Type	Description	Resource	Location
Shipment Created	/shipment#created	User has confirmed Flexport quote and cargo is getting ready to ship.	Shipment	None
Air Booking Confirmed*	/shipment#booking_confirmed	Shipment is booked with the air carrier.	Shipment	None
Updated Cargo Ready Date	/shipment#cargo_ready_date_changed	Cargo ready date changed from the original cargo ready date.	Shipment	None
Documents Sent to Nominated Broker	/shipment#documents_sent_to_nominated_broker	Arrival notice sent to client-nominated customs broker. Applicable to non-Flexport customs service shipments only.	Shipment	None
Commercial Invoices Digitized	/shipments#commercial_invoices_digitized	All commercial invoices have been entered into the Flexport system	Shipment	None
Customs Released	/shipment#customs_entry_release_status_released	Shipment cleared customs.	Shipment	None
Customs Hold	/shipment#customs_agriculture_hold /shipment#customs_entry_release_status_document_required /shipment#customs_entry_release_status_entry_docs_required /shipment#customs_entry_release_status_pending_intensive_exam /shipment#customs_entry_release_status_release_suspended /shipment#customs_entry_release_status_under_cbp_review /shipment#customs_undergoing_x_ray_exam /shipment#export_country_customs_exam /shipment#export_country_magnetism_exam	Shipment on customs hold or exam.	Shipment	None
Container Available*	/ocean/shipment_container_leg#available_for_pickup	Container becomes available for pickup from port.	ContainerLeg	location of the container
Delivery Appointment Requested*	/shipment_leg#delivery_appointment_requested	Date the delivery appointment was requested.	ShipmentLeg	delivery location
Delivery Appointment Scheduled	/shipment_leg#delivery_appointment_scheduled	Date of the scheduled delivery appointment.	ShipmentLeg	delivery location
Filing Submitted for in Bond Transportation	/shipment#filing_submitted_for_in_bond_transportation	Date when the filing was submitted.	Shipment	None
Free Time to Expire	/ocean/shipment_container#free_time_to_expire	Date when container free time expires.	Container	location of where the container will be when the container free time expires
Free Time Expired	/ocean/shipment_container#free_time_expired	Date when container free time expired.	Container	location of the container
FTZ Admission	/shipment#ftz_admission	Date when carrier is informed that the posted bill has been placed on a FTZ admission.	Shipment
Empty Equipment Returned	/ocean/shipment_container#empty_returned	Empty container returned to carrier.	Container	location of the container
Returned to Shipper	/shipment#returned_to_shipper	Some containers returned to shipper.	Shipment
[DEPRECATED] Delivery Appointment Scheduled	/shipment_container_leg#delivery_appointment_scheduled	Date and time of the scheduled delivery appointment.	ContainerLeg	delivery location
Cargo Breakdown Delay	/shipment#cargo_breakdown_delay	Delay due to cargo breakdown.	Shipment
Cargo Bumped from Booked Flight	/shipment#cargo_bumped_from_booked_flight	Delay due to cargo bumped from booked flight.	Shipment
Cargo Contamination Delay	/shipment#cargo_contamination_delay	Delay due to cargo contamination.	Shipment
Cargo Not Available	/shipment#cargo_not_available	Delay due to unavailable cargo.	Shipment
Cargo Ready Date Changed Exception	/shipment#cargo_ready_date_changed_exception	Delay due to a change in the cargo ready date.	Shipment
Cargo Rolled From Booked Vessel	/shipment#cargo_rolled_from_booked_vessel	Delay due to cargo being rolled from vessel.	Shipment
Dry Run: Pick Up Not Completed	/shipment#dry_run_pickup	Delivery not completed due to dry run pickup.	Shipment
Dry Run: Delivery Attempt Not Completed	/shipment#dry_run_delivery_attempt_not_completed	Delivery not completed due to no delivery attempt.	Shipment
Equipment Unavailable	/shipment#equipment_unavailable	Delay due to unavailable equipment.	Shipment
Flight Delay: Mechanical Problem	/shipment#flight_delay_mechanical	Delay due to mechanical issue with the airplane.	Shipment
Flight Delay: Schedule Updated By Carrier	/shipment#flight_delay_schedule_updated_by_carrier	Delay due to a flight schedule change made by the carrier.	Shipment
Late Bill of Lading Release	/shipment#late_bill_of_lading_release	Delay due to late bill of lading release.	Shipment
Missed Appointment	/shipment#missed_appointment	Delivery not completed due to missed appointment.	Shipment
Missing Cargo	/shipment#missing_cargo	Delay due to missing cargo.	Shipment
No Appointments Available	/shipment#no_appointments_available	Delay due to no appointments available.	Shipment
No Attempt Made	/shipment#no_attempt_made	Delivery not completed due to no delivery attempt.	Shipment
Ocean Port Dwell Delay	/shipment#ocean_port_dwell_delay	Delay due to dwell at ocean port.	Shipment
Pending Customs Clearance from Nominated Broker	/shipment#pending_customs_clearance_from_nominated_broker	Delay due to clearance pending from nominated broker.	Shipment
Pending Delivery Appointment Confirmation	/shipment#pending_delivery_appointment_confirmation	Delay due to a pending delivery appointment confirmation.	Shipment
Port Strike Delay	/shipment#port_strike_delay	Delay due to port strike.	Shipment
Rail Car Equipment Breakdown	/shipment#rail_car_equipment_breakdown	Delay due to rail car equipment breakdown.	Shipment
Rail Interchange Delay	/shipment#rail_interchange_delay	Delay due to rail interchange.	Shipment
Rail Transfer Delay	/shipment#rail_transfer_delay	Delay due to rail transfer.	Shipment
Shipment Re-Routed by Carrier	/shipment#shipment_rerouted_by_carrier	Delay due to reroute made by the carrier.	Shipment
Shipment Re-Routed per Client Request	/shipment#shipment_rerouted_per_client_request	Delay due to reroute per client request.	Shipment
Supplier Late Gate In	/shipment#supplier_late_gate_in	Delay due to late shipper gate-in.	Shipment
Supplier Late Documents	/shipment#supplier_late_documents	Delay due to late submission of shipper documents.	Shipment
Transload Delay	/shipment#transload_delay	Delay due to transload.	Shipment
Transshipment Delay	/shipment#transshipment_delay	Delay due to transshipment.	Shipment
Trucker Rejected	/shipment#trucker_rejected	Delivery not completed due to rejection at delivery site.	Shipment
Trucker's Hours Expired	/shipment#truckers_hours_expired	Delay due to expired trucker hours.	Shipment
Trucking Delay: Chassis Problem	/shipment#trucking_delay_chassis_problem	Delay due to a trucking chassis problem.	Shipment
Trucking Delay: Mechanical Problem	/shipment#trucking_delay_mechanical_problem	Delivery not completed due to truck mechanical problem.	Shipment
Trucking Delay: Port Congestion	/shipment#trucking_delay_port_congestion	Delay due to port congestion.	Shipment
Trucking Delay: Other	/shipment#trucking_delay_other	Delay due to other trucking reason.	Shipment
Trucking Delay: Strike	/shipment#trucking_delay_strike	Delay due to trucking strike.	Shipment
Trucking Delay: Traffic	/shipment#trucking_delay_traffic	Delay due to traffic.	Shipment
Vessel Delay: Mechanical Problem	/shipment#vessel_delay_mechanical	Delay due to mechanical issue with the vessel.	Shipment
Vessel Delay: Port Congestion	/shipment#vessel_delay_port_congestion	Delay due to port congestion.	Shipment
Vessel Delay: Schedule Updated By Carrier	/shipment#vessel_delay_schedule_updated_by_carrier	Delay due to a vessel schedule change made by the carrier.	Shipment
Warehouse Devan Delay	/shipment#warehouse_devan_delay	Delay due to warehouse devan.	Shipment
Weather Delay	/shipment#weather_delay	Delay due to weather conditions.	Shipment

For all Invoice Events, the data field of the Event webhook payload is an Invoice Event Data object. There is no direct access from the payload to shipment, location, or container information like there is in a Shipment Event Data object.

Name	Type	Description
Invoice Payment Made	/invoice#invoice_payment_made	Invoice payment has been made
Invoice Due Date Adjusted	/invoice#invoice_due_date_adjusted	Invoice payment due date has been adjusted
Invoice Shared	/invoice#invoice_shared	Invoice has been shared
Invoice Voided	/invoice#invoice_voided	Invoice has been voided
Invoice Credit Applied	/invoice#invoice_credit_applied	Invoice credit has been applied
Invoice Refund Applied	/invoice#invoice_refund_applied	Invoice refund has been applied
Invoice Payment Failed	/invoice#invoice_payment_failed	Invoice payment failed

For all Document Events, the data field of the Document webhook payload is a Document Event Data object. Depending on what the document is connected to, the payload may or may not contain shipment information.

Name	Type	Description
Document Created*	/document#document_created	A document has been created

For all PurchaseOrder Events, the data field of the Event webhook payload is a PurchaseOrder Event Data object. It contains PurchaseOrder header-level information, as well as context that is unique to each event.

Name	Type	Description
PurchaseOrder Acknowledged	/purchase_order#acknowledged	PurchaseOrder has been acknowledged
PurchaseOrder Updated	/purchase_order#updated	PurchaseOrder has been updated, currently only supports update through order collaboration flow