PlatformStatusAlertEvent
Notifies subscribers of alerts that occur during the processing of a user request or service job execution. This object is available in API version 45.0 and later.
For example, suppose that a formula is evaluated as part of processing user requests. A platform event message can be generated during the processing of a user request when an error is encountered from evaluating an invalid formula.
describeSObjects()
| Subscriber | Supported? |
|---|---|
| Apex Triggers |  |
| Flows | |
| Processes | |
| Pub/Sub API | |
| Streaming API (CometD) | |
/event/PlatformStatusAlertEvent
Accessing this object requires the Customize Application, Modify All Data, or Manage Next Best Action Strategies user permission.
Yes
Type: string
Properties: Nillable
Description: The API error code.
Type: string
Properties: Nillable
Description: Name of the component in which the alert occurred.
Type: datetime
Properties: Nillable
Description: Date and time when the event occurred. Example: 2018-12-18 21:59:48
Type: string
Properties: Nillable
Description: Unique identifier of the event. This field is reserved for future use and is always null in API version 45.0.
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.
Type: string
Properties: Nillable
Description: Extended error code which provides more details about the issue.
Type: string
Properties: Nillable
Description: EventIdentifier (uuid) of the related event. This field is reserved for future use and is always null in API version 45.0.
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.
Type: string
Properties: Nillable
Description: The unique ID of the service job that fired the event. It can be used to correlate the alert with logging information.
Type: string
Properties: Nillable
Description: Service-specific job ID, if one exists. For Next Best Action, the service job ID is executionToken. This field can be used to correlate the alert with logging information.
Type: string
Properties: Nillable
Description: Name of the service that triggered the alert.
Type: string
Properties: Nillable
Description: Status of the event.
Type: string
Properties: Nillable
Description: Name of the subcomponent where the alert occurs.
Type: string
Properties: Nillable
Description: Short description of the alert.
Type: reference
Properties: Nillable
Description: ID of the user who caused the event.
Type: string
Properties: Nillable
Description: Username of the user who caused the event.
The following example shows how to process platform status alert events. Only internal services can publish these events. This Apex trigger example fires when a platform event message is published and creates a Chatter post on the admin profile with event details.
The code example ultimately displays as a Chatter post that contains the following:
Alert occurred in the service: Next Best Action Strategy
APIErrorCode: INVALID_OPERATION
ComponentName: Strategy_for_error_event_demo
EventDate: 2018-12-18 21:59:48
EventIdentifier: null
ExtendedErrorCode: FORMULA_EXPRESSION_INVALID
RelatedEventIdentifier: null
ReplayId: 63
RequestId: TID:89715900005e40b69a
ServiceJobId: 1014fd4e-4a19-4910-be36-377a7f2f1b75
ServiceName: Next Best Action Strategy
StatusType: Error
SubComponentName: filter_node1
Subject: Something went wrong with filter element ‘filter_node1’: ‘Unknown function ISBLANC. Check spelling.’
UserId: 005RM000001ZnzAYAS
Username: xxx@yyy.com