OmniTrackingEvent
Notifies subscribers about a user interaction with a FlexCard or OmniScript that’s tracked for OmniAnalytics. This object is available in API version 60.0 and later.
This platform event is part of OmniStudio Standard, not OmniStudio for Vlocity.
describeSObjects()
| Subscriber | Supported? |
|---|---|
| Apex Triggers |  |
| Flows | |
| Processes | |
| Pub/Sub API | |
| Streaming API (CometD) | |
/event/OmniTrackingEvent
Using OmniAnalytics requires having an OmniStudio license and enabling OmniAnalytics in Setup.
Yes
Type: string
Properties: Nillable
Description: The full name of the FlexCard or OmniScript for which user interactions are tracked.
Type: picklist
Properties: Restricted picklist
Description: Required. The type of component for which user interactions are tracked. Possible values are:
Flexcard—A context-sensitive display of Salesforce data and clickable actions.Omniscript—A multi-page wizard that guides a user through a business process.
Type: string
Properties: None
Description: Required. The name of the user interaction or user inferface response, such as Card Load, Card Unload, or UI Action.
Type: textarea
Properties: None
Description: Required. The request payload sent for the user interaction, which typically includes data from the FlexCard or OmniScript.
Type: string
Properties: Nillable
Description: A universally unique identifier (UUID) that identifies a platform event message.
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: dateTime
Properties: None
Description: Required. The timestamp indicating when the event occurred.
Type: string
Properties: None
Description: Required. A category for this event and other events with a similar business purpose.
Type: string
Properties: None
Description: Required. The name of the related OmniTrackingGroup object.