List of standard webhook topics

Topic	Displayed Name	Description	Ordered	Message structure

Topic	Displayed Name	Description	Message structure
`buffer_import_completed`	Buffer Import Completed	Notifies when an async buffer import is completed	`buffer_import_completed` `import_id: string status: string`
`buffer_import_error_occurred`	Buffer Import Error Occurred	Notifies when a synchronous buffer import fails	`buffer_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_buffer_import_error_occurred`	Asynchronous Buffer Import Error Occurred	Notifies when an asynchronous buffer import fails	`async_buffer_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`customer_import_completed`	Customer Import Completed	Notifies when an async customer import is completed	`customer_import_completed` `import_id: string status: string`
`customer_import_error_occurred`	Customer Import Error Occurred	Notifies when a synchronous customer import method fails	`customer_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_customer_import_error_occurred`	Asynchronous Customer Import Error Occurred	Notifies when a asynchronous customer import fails	`async_customer_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`transfer_import_completed`	Transfer Import Completed	Notifies when an async transfer import is completed	`transfer_import_completed` `import_id: string status: string`
`transfer_import_error_occurred`	Transfer Import Error Occurred	Notifies when a synchronous transfer import fails	`transfer_import_error_occurred` `error: string invalid_transfers: string request_body: string date: int64`
`async_transfer_import_error_occurred`	Asynchronous Transfer Import Error Occurred	Notifies when an asynchronous transfer import fails	`async_transfer_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`stock_import_completed`	Stock Import Completed	Notifies when an async stock import is completed	`stock_import_completed` `import_id: string status: string`
`stock_import_error_occurred`	Stock Import Error Occurred	Notifies when a synchronous stock import fails	`stock_import_error_occurred` `error: string error_content: string import_id: string request_body: string date: int64`
`async_stock_import_error_occurred`	Asynchronous Stock Import Error Occurred	Notifies when an asynchronous stock import fails `message`is formatted as `"<error>: id1, id2, id3, …"` with `error` being one of: `invalid_endpoint` `invalid_item` `invalid_stock_type`	`async_stock_import_error_occurred` `import_id?: string errors: [] message: string date: int64`
`line_item_group_state_changed`	Line Item Group State Change	Notifies of a state change for line item groups	`line_item_group_state_changed` `{ "order_id": "string", "date": int64, "old_state": "returning", "new_state": "returned", "order_item_id": "string", "index_ranges": [ { "start": int64, "end": int64 } ], "quantity": int64 }`
`bundle_state_changed`	Bundle State Change	Notifies of a state change for bundles	`bundle_state_changed` `{ "order_id": "string", "date": int64, "old_state": "returning", "new_state": "returned", "order_item_id": "string", "index_ranges": [ { "start": int64, "end": int64 } ], "quantity": int64 }`
`order_state_changed`	Order State Change	Notifies of a state change for orders	`order_state_changed` `order_id: string date: int64 old_state: string new_state: string`
`parcel_state_changed`	Parcel State Change	Notifies of a state change for parcels	`parcel_state_changed` `order_id: string date: int64 old_state: string new_state: string parcel_id: string`
`line_item_group_entity_updated` `order_entity_updated` `parcel_entity_updated`	Entity Update	Notifies of OMS entities information changes (parcels, line item groups and orders) POP (endpoint_orders, containers, piece_groups) and RM (return_parcels, and return_line_item_groups)	`line_item_group_entity_updated`,`order_entity_updated`, `parcel_entity_updated` `site_id: string entity_id: string entity_type: string date: int64 diff: map[string]any` Example of diff content : `{ "customer.information.fidelity_card": { "old": "1864511344", "new": "1946396581" } }`
`orchestration_rules_changed`	Orchestration Rules Changed	`shipping_instructions_computed` is preferred for the below usage. Allows triggering of preparation order on time. When there is an orchestration rule change with a warehouse custom claim action triggered, line item groups are retrieved and a preparation order is sent to the warehouse.	`orchestration_rules_changed` `order_id: string ruleset_id: string from: string to: string custom_actions: [] action: string rule_index: string line_item_index_ranges: indexRange rules_over: string`
`candidates_added`	Candidates Added	Notifies that an endpoint is candidate for an order.	`candidates_added` `site_id: string order_id: string endpoint_ids: []string`
`candidates_removed`	Candidates Removed	Notifies when an endpoint is no longer candidate for an order.	`candidates_removed` `site_id: string order_id: string endpoint_ids: []string`
`rules_over` `orchestration_rules_over` v2	Rules Over	Notifies of a rules over transition for an order.	`orchestration_rules_over` `site_id: string order_id: string ruleset_id: string line_item_index_ranges: IndexRanges` `rules_over` `site_id: string order_id: string ruleset_id: string`
`back_from_rules_over`	Back From Rules Over	Notifies back from rules over	`back_from_rules_over` `site_id: string order_id: string ruleset_id: string`
`item_import_completed`	Item Import Completed	Notifies of a completed item import	`item_import_completed` `import_id: string status: string`
`item_import_error_occurred`	Item Import Error Occurred	Notifies when a synchronous item import using API POST /items or a PATCH /items method fails	`item_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_item_import_error_occurred`	Asynchronous Item Import Error Occurred	Notifies when an asynchronous item import fails	`async_item_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`psp_error_occurred`	Payment Error	Notifies of errors during payment treatment	`psp_error_occurred` `psp: string request_route: string request_body: string response_body: string`
`container_state_changed` `operator_state_changed` `endpoint_order_state_changed` `piece_group_state_changed`	Order Preparation Entity Change	Notifies of order preparation entity state changes (creation, update, removal)	`container_state_changed, operator_state_changed`, `endpoint_order_state_changed`and `piece_group_state_changed` `entity_id string entity_type string site_id string date string old_state string new_state string`
`return_parcel_created` DEPRECATED This topic is deprecated. It will be deleted as of v15 release (7 Apr. 2025 in qualification, 22 Apr. 2025 in production). The creation of return parcels are now sent to the return_parcel_state_changed topic.	Return Parcel Creation	Notifies of the creation of a return parcel
`return_parcel_state_changed`		Notifies of a state change for a return_parcel In case of return_parcel creation, `old_state` will be empty	`return_parcel_state_changed` `{ "date": int64, "old_state": "returning", "new_state": "returned, "order_id": string, "return_parcel_id": string }`
`return_line_item_group_state_changed`		Notifies of a state change for a return_line_item_group	`return_line_item_group_state_changed` `{ "date": int64, "old_state": "returning", "new_state": "returned", "order_id": "string", "return_parcel_id": "string", "index_ranges": [ { "start": int64, "end": int64 } ], "quantity": int64 }`
`line_items_reservations_updated`	Line Items Reservations Update	Notifies of a reservation update on a line item group (global reservation to endpoint reservation, future stock to on hand, endpoint reservation removal)	`line_items_reservations_updated` added_reservations: [] id: string order_id: string sales_channel: string global: string line_item_index_ranges: index_ranges quantity: int64 item_id: string endpoint_id: string eta_start: int64 eta_end: int64 stock_type: string purchase_order_number: string remaining_line_item_index_ranges: index_ranges removed_reservations: [] id: string order_id: string sales_channel: string global: string line_item_index_ranges: index_ranges quantity: int64 item_id: string endpoint_id: string eta_start: int64 eta_end: int64 stock_type: string purchase_order_number: string remaining_line_item_index_ranges: index_ranges
`stock_coverage_import_completed`	Stock Coverage Import Completed	Notifies of a completed stock coverage import	`stock_coverage_import_completed` `import_id: string status: string`
`stock_coverage_import_error_occurred`	Stock Coverage Import Error Occurred	Notifies when a synchronous stock coverage import fails	`stock_coverage_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_stock_coverage_import_error_occurred`	Asynchronous Stock Coverage Import Error Occurred	Notifies when an asynchronous stock coverage import fails	`async_stock_coverage_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`stock_disposition_import_completed`	Stock Disposition Import Completed	Notifies of a completed stock disposition import	`stock_disposition_import_completed` `import_id: string status: string`
`stock_disposition_import_error_occurred`	Stock Disposition Import Error Occurred	Notifies when a synchronous stock disposition import fails	`stock_disposition_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_stock_disposition_import_error_occurred`	Asynchronous Stock Disposition Import Error Occurred	Notifies when an asynchronous stock disposition import fails	`async_stock_disposition_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`endpoint_import_completed`	Endpoint Import Completed	Notifies of a completed stock import	`endpoint_import_completed` `import_id: string status: string`
`endpoint_import_error_occurred`	Endpoint Import Error Occurred	Notifies when a synchronous endpoint import fails	`endpoint_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_endpoint_import_error_occurred`	Asynchronous Endpoint Import Error Occurred	Notifies when an asynchronous endpoint import fails	`async_endpoint_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`user_import_completed`	User Import Completed	Notifies of a completed user import	`user_import_completed` `import_id: string status: string`
`user_import_error_occurred`	User Import Error Occurred	Notifies when a synchronous user import fails	`user_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`async_user_import_error_occurred`	Asynchronous User Import Error Occurred	Notifies when an asynchronous user import fails	`async_user_import_error_occurred` `import_id?: string errors: [] entity_id?: string message: string date: int64`
`carrier_error_occurred`	Carrier Error	Relays of errors during carrier communication	`carrier_error_occurred` `carrier: string request_route: string request_body: string response_body: string`
`tracking_link_created`		Notifies of the creation of a tracking link associated to a parcel (return parcel tracking link creation is not notified on this topic)	`tracking_link_created` `carrier: string tracking_link: string`
`shipment_created`		Notifies of the creation of a shipment associated to a parcel (return parcel shipment creation is not notified on this topic)	`shipment_created` `carrier: string endpoint_id: string order_id: string parcel_id: string shipment_id: string user_id: string`
`stock_export_completed`	Stock Export Completed	Notifies the completion of a stock export by file (SFTP) File name and other information regarding the import can be retrieved through a `GET /file_jobs/:file_job_id { "site_id" : "your_site_id", "token" : "your_token", "fields" : [ "id", "name", "tmp_file_id", "type", "is_output", "translator_id", "usr_id", "site_id", "error", "nb_line_written", "nb_line_tried", "nb_line_to_write", "nb_line_errors", "created_at", "started_write_at", "finished_at", "sftp_name" ] }`	`export_id string file_job_id string exported_lines_count int64`
`order_expiration_reached`	Order Expiration Reached	Notifies when an order expiration date is reached The notification is created using the `set_expiration_date` action in the workflow of orders	`order_expiration_reached` `object_id: string object_type: string order_id: string expiration_name: string`

List of standard webhook topics

buffer_import_completed

buffer_import_error_occurred

async_buffer_import_error_occurred

customer_import_completed

customer_import_error_occurred

async_customer_import_error_occurred

transfer_import_completed

transfer_import_error_occurred

async_transfer_import_error_occurred

stock_import_completed

stock_import_error_occurred

async_stock_import_error_occurred

line_item_group_state_changed

bundle_state_changed

order_state_changed

parcel_state_changed

line_item_group_entity_updated

order_entity_updated

parcel_entity_updated

orchestration_rules_changed

candidates_added

candidates_removed

rules_over

orchestration_rules_over v2

back_from_rules_over

item_import_completed

item_import_error_occurred

async_item_import_error_occurred

psp_error_occurred

container_state_changed

operator_state_changed

endpoint_order_state_changed

piece_group_state_changed

return_parcel_created

DEPRECATED

This topic is deprecated. It will be deleted as of v15 release (7 Apr. 2025 in qualification, 22 Apr. 2025 in production).

The creation of return parcels are now sent to the return_parcel_state_changed topic.

return_parcel_state_changed

return_line_item_group_state_changed

line_items_reservations_updated

stock_coverage_import_completed

stock_coverage_import_error_occurred

async_stock_coverage_import_error_occurred

stock_disposition_import_completed

stock_disposition_import_error_occurred

async_stock_disposition_import_error_occurred

endpoint_import_completed

endpoint_import_error_occurred

async_endpoint_import_error_occurred

user_import_completed

user_import_error_occurred

async_user_import_error_occurred

carrier_error_occurred

tracking_link_created

shipment_created

stock_export_completed

order_expiration_reached

`buffer_import_completed`

`buffer_import_error_occurred`

`async_buffer_import_error_occurred`

`customer_import_completed`

`customer_import_error_occurred`

`async_customer_import_error_occurred`

`transfer_import_completed`

`transfer_import_error_occurred`

`async_transfer_import_error_occurred`

`stock_import_completed`

`stock_import_error_occurred`

`async_stock_import_error_occurred`

`line_item_group_state_changed`

`bundle_state_changed`

`order_state_changed`

`parcel_state_changed`

`line_item_group_entity_updated`

`order_entity_updated`

`parcel_entity_updated`

`orchestration_rules_changed`

`candidates_added`

`candidates_removed`

`rules_over`

`orchestration_rules_over` v2

`back_from_rules_over`

`item_import_completed`

`item_import_error_occurred`

`async_item_import_error_occurred`

`psp_error_occurred`

`container_state_changed`

`operator_state_changed`

`endpoint_order_state_changed`

`piece_group_state_changed`

`return_parcel_created`

`return_parcel_state_changed`

`return_line_item_group_state_changed`

`line_items_reservations_updated`

`stock_coverage_import_completed`

`stock_coverage_import_error_occurred`

`async_stock_coverage_import_error_occurred`

`stock_disposition_import_completed`

`stock_disposition_import_error_occurred`

`async_stock_disposition_import_error_occurred`

`endpoint_import_completed`

`endpoint_import_error_occurred`

`async_endpoint_import_error_occurred`

`user_import_completed`

`user_import_error_occurred`

`async_user_import_error_occurred`

`carrier_error_occurred`

`tracking_link_created`

`shipment_created`

`stock_export_completed`

`order_expiration_reached`