Fluent Commerce Docs

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Content in this track:

Introduction to Integrations and Connections

Introduction to the Events API

End Of Track

Content in this track: Introduction to the Events API

Essential knowledge

Authors:

Ankit Mehta, Movyn John, Cille Schliebitz, Anita Gu

Changed on:

24 Oct 2025

Overview

The Events API is a core component of the Fluent Platform, enabling the creation and management of events that drive workflow logic and system activity tracking. It supports asynchronous operations for optimized performance and integrates with systems for inventory updates, product data transfer, fulfillment, and carrier tracking.

Key points

Events are fundamental to the Fluent Platform, representing actions or occurrences within the system.
The Events API enables viewing and creating events, supporting workflow logic and system activity tracking.
`ORCHESTRATION` events trigger workflows, while `ORCHESTRATION_AUDIT` events log workflow execution details.
Common Event API operations include retrieving events by ID, filtering events, and creating new events asynchronously.
Event Contracts are defined by Rulesets in workflows, combining event attributes to handle specific processes.
Recommended practice: Use asynchronous integration for non-real-time actions to optimize performance.
Common integrations include inventory updates, product master data transfer, fulfillment updates, and carrier tracking.

Events

Events are a fundamental part of the Fluent Platform and represent something that has happened, is happening, or will happen within the system. An Event is typically used to trigger the system to perform an action or log activity within the system. Not only are they used to trigger workflow logic, but they are also used to capture all events that occur within the system. Next, let's look at Events from an Integration and Connection point of view, with Events API.

Supporting Learning Materials: Event-Driven Architecture Webinar

Technical consultants, Ankit Mehta and Jamie Madrid, share insights on the foundations and fundamentals of event-driven architecture.

Events API

ORCHESTRATION events are used to trigger the execution of workflow logic, while the `ORCHESTRATION_AUDIT` events describe what happened during that workflow execution. API events, such as `ORCHESTRATION_AUDIT` events, describe what happens within the system, rather than triggering any behavior.The Event API allows users and external systems to view and create events within the Fluent Platform.Here, we look at some Get/Post Event API operations.

`/event/{eventId}`	Get an Event by IdReturns the Event identified by the `<eventId>` parameter. Returns a 404 HTTP Status code if not found.Authentication: Required
`/event`	Finds all events for the given criteriaReturns a page of events filtered by the given combination of parameters. If no parameters are provided, the default page size, date range, and sort order will be applied, and the events for which your authenticated user is authorized will be returned.Authentication: Required
`/event/async`	Creates a new Event in the Fluent PlatformCreates a new Event within the Fluent Platform to trigger a part or whole of a workflow.Authentication: Required

Learn more about the parameters and responses here (opens in a new tab).

Note

The Event API is currently only available in REST.

Sample Event to Trigger a Ruleset

Following are the main fields of an event

`name`: This is the name of the event that matches with the ruleset in the respective workflow.
`retailerId`: This is Fluent OMS's retailer ID.
`entityType`: The entity against which the event is triggered. Example: `FULFILMENT`, `LOCATION`, `INVENTORY_POSITION`, etc.
`entityId`: The ID of the entity against which the event is triggered. Example: `fulfilmentId`, `locationId`, etc.
`entityRef`: The ref of the entity against which the event is triggered. Example: `inventoryPositionRef`, etc.
`rootEntityType`: The root entity against which the event is triggered. Example: `ORDER`, `INVENTORY_CATALOGUE`, etc.
`rootEntityId`: The ID of the root entity against which the event is triggered. Example: `orderId`, etc.
`rootEntityRef`: The ref of the root entity against which the event is triggered. Example: `orderRef`, `inventoryCatalogueRef`, etc.
`attributes`: The event attributes passed to the ruleset handling the event, these attributes are used by the rules of the ruleset.

Note

entityId/rootEntityId are required for events against legacy entities, like ORDER, FULFILMENT, LOCATION, etc.
entityRef/rootEntityRef are required for events against Global Inventory entities, like INVENTORY_CATALOGUE, INVENTORY_POSITION, etc.

Event Contracts & Relationship to Workflow

An Event Contract is defined by the Rulesets in a Workflow. And, within that Ruleset, all the rules that define event attributes combine to form the Event Contract for that Ruleset.

Example: Event Contract and Rulesets relationship

If you have a Ruleset that expects a certain set of values, such as the brand name, product reference, or expected category, then the Rules within that Ruleset that validate those incoming attributes are what's referred to as the Event Contract.

Recommended Practice: Use Async integration (`https://<ACCOUNTID>.sandbox.api.fluentretail.com/api/v4.1/event/async`), unless there is a real-time action (user interaction, `fulfilment` options) in it. Common Integrations: Some common integrations that use the Events API are:Custom Inventory Integration: Events are used if the Batch API cannot meet the client's inventory mechanism or requirement. For example: Delta Inventory EventProduct Master Integration: External events from the Product Master (PIM) can be passed to the Fluent OMS to create Categories, Standard and Variant Products. WMS Integration-Inbound (Pick / Ship Confirmation): Any fulfillment updates, like Pick / Ship Confirmation, are sent to the Fluent OMS using events.Carrier Integration: Any updates from the Carrier provider around Consignment and Tracking Details are sent to the Fluent OMS through events.

Knowledge Tracks Related To This Topic

Integrate and Connect

Introduction to Integrations and Connections

Introduction to GraphQL

Introduction to the Events API

Introduction to Webhooks

Inventory Batches

Connectors

Integrate and Connect Labs

Content in this track:

Introduction to Integrations and Connections

Introduction to GraphQL

Introduction to the Events API

Introduction to Webhooks

Inventory Batches

Connectors

Integrate and Connect Labs

End Of Track

Introduction to the Events API

Introduction to the Events API

Overview

Key points

Events

Supporting Learning Materials: Event-Driven Architecture Webinar

Events API

Sample Event to Trigger a Ruleset

Event Contracts & Relationship to Workflow

Ankit Mehta

Contributors:

Knowledge Tracks Related To This Topic

Building Blocks

By Type

Helpful Resources

Quick Links