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
FlowExecutionErrorEvent
FOStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
PublishStatusEvent (Pilot)
PublishStatusDetail (Pilot)
RemoteKeyCalloutEvent
Real-Time Event Monitoring Objects
PDF

Newer Version Available

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

PublishStatusEvent (Pilot)

Tracks the results of one or more asynchronous publish operations of high-volume platform events. The results are grouped by status and event API name. 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()

Supported Subscribers

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

Streaming API Subscription Channel

/event/PublishStatusEvent

Fields

Field Details
AdditionalInfo
Type
string
Properties
Nillable
Description
Reserved for future use. Optional information about the event that is not provided in the other fields.
PublishStatusDetails
Type
PublishStatusDetail[]
Properties
Nillable
Description
A list of event publish operation results, including information about each event.
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.
Status
Type
picklist
Properties
Nillable, Restricted picklist
Description
The status of the event publish operations.
Possible values are:
  • FAILURE—The event message couldn’t be published due to a transient failure in the system. Try republishing the event message.
  • INDETERMINATE—The publishing status couldn’t be determined. The event message might be lost.
  • INVALID—The event message caused a validation error. Ensure your event message is valid before you republish it.
  • ROLLBACK—The event message was rolled back and wasn't published because the transaction was rolled back. This status applies to events configured with the Publish after Commit publish behavior.
  • SUCCESS—The event message was published successfully.
Topic
Type
string
Properties
Nillable
Description
The API name of the platform event. For example, MyEvent__e.