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
Considerations
Examples
Reference
Platform Event Allocations
EventBusSubscriber
EventBus Class
Platform Event Error Status Codes
TriggerContext Class
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AIPredictionEvent
AIUpdateRecordEvent
AssetTokenEvent
AsyncOperationEvent (Beta)
AsyncOperationStatus
BatchApexErrorEvent
FlowExecutionErrorEvent
PlatformStatusAlertEvent
RemoteKeyCalloutEvent
Real-Time Event Monitoring Objects
PDF

Newer Version Available

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

AsyncOperationStatus

Represents the status of an asynchronous operation, such as an event publish operation. This object is included in a streamed notification received on the /event/AsyncOperationEvent channel. You can’t subscribe to the AsyncOperationStatus event channel directly. This object is available in API version 46.0 and later.

Supported Calls

describeSObjects()

Fields

Field Name Details
Category
Type
picklist
Properties
Nillable, Restricted picklist
Description
The category for this error notification. Possible values are:
  • PlatformEventPersistenceError
  • PlatformEventPublishError
Fields
Type
string[]
Properties
Nillable
Description
Additional information about the error. The array contains one field only: the type of the platform event that failed to publish (HighVolumePlatformEvent).
Message
Type
string
Properties
Nillable
Description
The status message or error message of the operation.
Status
Type
picklist
Properties
Nillable, Restricted picklist
Description
The status of the asynchronous operation. Valid values are:
  • SUCCESS
  • FAILURE
StatusCode
Type
string
Properties
Nillable
Description
The status code of the error if the operation failed. For example, a failure in an event publishing operation results in the PLATFORM_EVENT_PUBLISH_FAILED status code.