FlowExecutionErrorEvent

Notifies subscribers of errors related to screen flow executions. This object is available in API version 47.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

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

Event Delivery Allocation Enforced

Yes

Fields

ContextObject

Description: Reserved for future use.

ContextRecordId

Description: Reserved for future use.

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. This field always contains a value.

EventIdentifier

Type: string

Properties: None

Description: Required. The unique ID of the event, which is shared with the corresponding storage object. For example, 0a4779b0-0da1-4619-a373-0a36991dff90. Use this field to correlate the event with its storage object. This field always contains a value.

EventUuid

Type: string

Properties: Nillable

Description: A universally unique identifier (UUID) that identifies a platform event message. This field is available in API version 52.0 and later.

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. This field always contains a value.

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. This field always contains a value.

FlowExecutionEndDate

Description: Reserved for future use.

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. This field always contains a value.

InterviewBatchId

Description: Reserved for future use.

InterviewGuid

Type: string

Properties: None

Description: Required. The globally unique identifier of the error-generating flow interview. This field always contains a value.

InterviewRequestId

Description: Reserved for future use.

InterviewStartDate

Type: dateTime

Properties: None

Description: Required. The date and time when the error-generating flow interview starts. This field always contains a value.

InterviewStartedById

Type: reference

Properties: None

Description: Required. The ID of the flow interview when it was started. This field always contains a value.

ProcessType

Type: string

Properties: Nillable

Description: The type of the flow. Valid value is:

Possible values:

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

Description: Reserved for future use.

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

Description: Reserved for future use.