Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

FlowOrchestrationEvent

Notifies subscribers that a paused instance of an orchestration is ready to be resumed. This object is available in API version 53.0 and later.

A FlowOrchestrationEvent is automatically published when an assigned user completes a screen flow associated with an interactive step, when an asynchronous background step is completed, or when a MuleSoft step is completed.

Supported Calls

create(), describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Event Delivery Allocation Enforced

Fields

Field	Details
EventPayload	Type textarea Properties Create, Nillable Description Output parameters from the interactive, asynchronous background step, or MuleSoft step that generated the event. Setting the payload for manually published flow orchestration events isn't supported.
EventUuid	Type string Properties Nillable Description A universally unique identifier (UUID) that identifies a platform event message.
OrchestrationInstanceId	Type string Properties Create Description The orchestration instance being tracked.
ReplayId	Type string Properties Nillable Description Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
StepInstanceId	Type string Properties Create, Nillable Description The ID of the step instance that generated the event.
StepStatus	Type picklist Properties Create, Nillable, Restricted picklist Description The resultant status of the step instance that generated the event. If specified, StepInstanceId is required. Possible values are: `Canceled`—For internal use only. `Completed`—The step instance completed. `Discontinued`—For internal use only. `Error`—The step instance or a screen flow associated with the step encountered an error. `InProgress`—For internal use only. `NotStarted`—For internal use only. `Suspended`—For internal use only. This field is available in API version 55.0 and later.

Platform Events Developer Guide

FlowOrchestrationEvent

Supported Calls

Supported Subscribers

Event Delivery Allocation Enforced

Fields