Skip to main content
Bold publishes business events when relevant entities change. Exact names and versions are exposed through the environment’s events API.
Always use the list from the environment you are integrating with. New features can add available events. These endpoints require application access.

​
Event families

Catalog

Changes to products, items, properties, and variants.

Warehouse

Receipts, shipments, lots, locations, inventories, and stock movements.

Planning

Sales orders, purchase orders, demand, supply, and forecasts.

Production

Requests, orders, operations, recipes, progress, pauses, and completion.

Maintenance

Assets, maintenance work orders, consumption, time, and completion.

Costs and people

Cost changes, employees, and related tasks.

​
Example names

Names follow the Domain.Entity.Action pattern.
Do not construct event names manually. Use /v1/notifications/events/versions to read the environment’s eventName and eventVersion.

​
Choose an event

1

Identify the business change

Decide whether you need to know that a line was confirmed, a receipt was completed, or an order changed state.
2

Check the name and version

Use the available events endpoint to obtain the current contract.
3

Subscribe only to what you need

Avoid broad subscriptions if your integration only needs one event family.
4

Version your consumer

Treat eventVersion as part of the contract. Do not mix versions without testing the data sent.

​
Subscription example

When an event only tells you that something changed, call the API with the identifier received to get the current state before updating your system.