Newer Version Available

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

FlowExecutionErrorEvent

Notifies subscribers of errors related to screen flow executions. Messages for this platform event aren’t published for autolaunched flows or processes. This object is available in API version 47.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

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

Fields

Field Details
ElementApiName
Type
string
Properties
Nillable
Description
The API name of the flow element that was executed when the flow execution error occurred.
ElementType
Type
string
Properties
Nillable
Description
The type of flow element.
ErrorId
Type
string
Properties
Nillable
Description
The ID of the error.
ErrorMessage
Type
string
Properties
Nillable
Description
The message about the error that occurred.
EventDate
Type
dateTime
Properties
None
Description
Required. The date and time when the error occurred.
EventIdentifier
Type
string
Properties
None
Description
Required. The unique identifier used to identify the error event.
EventType
Type
string
Properties
None
Description
Required. The type of flow event. Valid value is Error—An event that occurs when a flow execution generates an error.
ExtendedErrorCode
Type
string
Properties
Nillable
Description
The code that references more details about the error.
FlowApiName
Type
string
Properties
None
Description
Required. The API name of the flow that the error occurred for.
FlowExecutionEndDate
Type
dateTime
Properties
Nillable
Description
The date and time when the error-generating flow execution ends.
FlowExecutionStartDate
Type
dateTime
Properties
Nillable
Description
The date and time when the error-generating flow execution starts.
FlowNamespace
Type
string
Properties
Nillable
Description
The namespace of the error-generating flow.
FlowVersionId
Type
string
Properties
None
Description
Required. The ID of the error-generating flow version.
InterviewBatchId
Type
string
Properties
Nillable
Description
The ID of the batch that includes the error-generating flow interview.
InterviewGuid
Type
string
Properties
None
Description
Required. The globally unique identifier of the error-generating flow interview.
InterviewRequestId
Type
string
Properties
Nillable
Description
The ID of the request that includes the error-generating flow interview.
InterviewStartDate
Type
dateTime
Properties
None
Description
Required. The date and time when the error-generating flow interview starts.
ProcessType
Type
string
Properties
Nillable
Description
The type of the flow. Valid value is:
  • Flow—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab.
RelatedRecordId
Type
string
Properties
Nillable
Description
The IDs of records that are related to the error-generating flow.
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.
StageQualifiedApiName
Type
string
Properties
Nillable
Description
The qualified API name of the flow stage where the error occurred.
UserId
Type
reference
Properties
Namepointing, Nillable
Description
The ID of the user who starts the error-generating flow.
Username
Type
string
Properties
Nillable
Description
The username of the user or app who started the error-generating flow.