Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

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.

Supported Calls

create(), describeSObjects()

Supported Subscribers

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

Fields

Field	Details
EventPayload	Type textarea Properties Create, Nillable Description Output parameters from the interactive or asynchronous background step that generated the event.
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. This field is available in API version 55.0 and later.