Skip to main content

Events in Orchestration Engine

This feature is currently available as a Private Preview only

During a Private Preview, only customers who have agreed to our Private Preview usage agreements can access this feature. Additionally, the features documented here are subject to change and / or cancellation, so they may not be available to all users in future.

For more information about our Private Preview releases, including the level of Support offered with them, see: Feature release types.

Process Orchestrations can be started by external events. These events can be sent to a configured Orchestration Engine event-receiver endpoint, for instance, when a new order is placed.

Creating events

To create an event in Orchestration Engine:

  1. Select a Start a Process that opens a side panel with Events.

    Orchestration Engine process overview screen with the "Create event" option highlighted.

  2. Click Create Event.

  3. Specify the Display and Event names.

    • Display name is the name that is visible in the UI when you create a process, for example: Order Created.

    • Event name is the name of the registered event, for example: start-the-process

  4. Save your changes.

    All created events will be available in all processes in the package.

Accessing events in Action Flows

To be part of the orchestrated process, Action Flows must have a completion event in it. You can add it in a dedicated module in an Action Flow:

  1. In your Action Flow module, from the Event type dropdown list, select the completion event.

  2. Complete the module's configuration.

Once the Action Flow is published, active, and set to on-demand, you will be able to select this event to start the Process and see this Action Flow in the process step in your process.