Platform Events Developer Guide

Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
Reference
Platform Event Allocations
Platform Event Error Status Codes
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AcademicTermGpaCalcEvent
AcadRgstrApplnEvent
AcadRgstrEligCritRunEvent
AIPredictionEvent
AIUpdateRecordEvent
AppointmentSchedulingEvent
AssetCancelInitiatedEvent
AssetAmendInitiatedEvent
AssetRenewInitiatedEvent
AssetTokenEvent
BatchApexErrorEvent
BillingScheduleCreatedEvent
BulkApi2JobEvent (Beta)
CallCoachConfigModifyEvent
CommerceDiagnosticEvent
ConsentEvent
ConsentUnsubscribeAllEvent
ConversationInsightEvent
CreateAssetOrderEvent
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
DataObjectDataChgEvent
DataObjectMetadataChgEvent
DatasetExportEvent
DiscoveryPredictionEvent
EmailCapturedMatchEvent
ExtlRecShrEvent
ExtlRecShrResultEvent
FirstBillPaymentSetupEvent
FlowExecutionErrorEvent
FlowOrchestrationEvent
FOStatusChangedEvent
FulfillOrdItemQtyChgEvent
InsPlcyEndrStatusEvent
InsPolicyRnwlQuoteStatusEvent
InsPolicyRnwlStatusEvent
InteropTopicSubcrEvent
InvoiceProcessedEvent
InvoiceProcPymtExclEvent
NegInvcLineProcessedEvent
OmniTrackingEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PaymentCreationEvent
PendingOrdSumProcEvent
PlaceOrderCompletedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
QuoteSaveEvent
QuoteToOrderCompletedEvent
RealtimeAlertEvent
RemoteKeyCalloutEvent
SrcPredJobStatusChgEvent
SearchIndexJobStatusEvent
ServiceAppointmentEvent
VoidInvoiceProcessedEvent
WebCartAbandonedEvent
WebStoreUserCreatedEvent
Real-Time Event Monitoring Objects
PDF

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.

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 Yes
Processes
Pub/Sub API
Streaming API (CometD)

Event Delivery Allocation Enforced

No

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.