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
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
AppointmentSchedulingEvent
AssetTokenEvent
BatchApexErrorEvent
CommerceDiagnosticEvent
ConsentEvent
DatasetExportEvent
FlowExecutionErrorEvent
FOStatusChangedEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
PublishStatusEvent (Beta)
PublishStatusDetail (Beta)
RemoteKeyCalloutEvent
Real-Time Event Monitoring Objects
PDF

Newer Version Available

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

PublishStatusDetail (Beta)

Represents the result of an asynchronous publish operation of a high-volume platform event, and contains information about the event. You can't subscribe to this object, but you can subscribe to PublishStatusEvent, which includes this object. This object is available in API version 49.0 and later.

As a beta feature, Publish Status Events is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. You can provide feedback and suggestions for Publish Status Events in the Trailblazer Community. For information on enabling this feature in your org, contact Salesforce.

Note

Supported Calls

describeSObjects()

Fields

Field Details
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies the platform event message for which the publish result is provided in this object. This UUID is returned in the SaveResult of a publish call. Use EventUuid to match the event result with the event published.
FailureReason
Type
string
Properties
Nillable
Description
The error message explaining the cause of a failed event publish.
Replay
Type
long
Properties
Nillable
Description
If the event publish was successful, this field contains the replay ID of the published event.
StatusCode
Type
string
Properties
Nillable
Description
The error status code of an event publish failure.