Detects when a user creates, accesses, updates, or deletes a record in Salesforce Classic only. Doesn’t detect record operations done through a Visualforce page or Visualforce page views. This object is available in API version 46.0 and later.
Supported Calls
describeSObjects()
Supported Subscribers
Subscriber
Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)
Subscription Channel
/event/UriEventStream
Special Access Rules
Accessing this object requires either the Salesforce Shield or Salesforce Event Monitoring add-on subscription and the View Real-Time Event Monitoring Data user permission.
Description: The time when the specified URI event was captured (after query execution takes place). For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting.
EventIdentifier
Type: string
Properties: Nillable
Description: The unique ID of the event, which is shared with the corresponding storage object. For example, 0a4779b0-0da1-4619-a373-0a36991dff90. Use this field to correlate the event with its storage object.
EventUuid
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.
LoginKey
Type: string
Properties: Nillable
Description: The string that ties together all events in a given user’s login session. The session starts with a login event and ends with either a logout event or the user session expiring. For example, 8gHOMQu+xvjCmRUt
Message
Type: string
Properties: Nillable
Description: The failure message if the operation being performed on the entity failed (OperationStatus=Failure).
Name
Type: string
Properties: Nillable
Description: The value of the record being viewed or edited.
Operation
Type: picklist
Properties: Nillable, Restricted picklist
Description: The operation being performed on the entity. For example, Read, Create, Update, or Delete. Create and update operations are captured in pairs; that is, expect two event records for each operation. The first record represents the start of the operation, and the second record represents whether the operation was successful or not. The two records are correlated by RelatedEventIdentifier. If there isn’t a second event recorded for a create or update operation, then the user canceled the operation, or the operation failed with client-side validation (for example, when a required field is empty).
OperationStatus
Type: picklist
Properties: Nillable, Restricted picklist
Description: Whether the operation performed on the entity (such as create) succeeded or failed. When the operation starts, the value is always INITIATED. Possible values are:
Failure—The operation failed.
Initiated—The operation started.
Success—The operation succeeded.
Create and update operations can generate an extra OperationStatus=Initiated event after an operation fails. Ignore this extra record.
Note
ProfileId
Type: reference
Properties: Nillable
Description: This is a relationship field.
Relationship Name: Profile
Refers To: Profile
QueriedEntities
Type: string
Properties: Nillable
Description: The API name of the objects referenced by the URI.
RecordId
Type: string
Properties: Nillable
Description: The id of the record being viewed or edited. For example, 001RM000003cjx6YAA.
RelatedEventIdentifier
Type: string
Properties: Nillable
Description: Represents the EventIdentifier of the related 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.
RoleId
Type: reference
Properties: Nillable
Description: This is a relationship field.
Relationship Name: Role
Refers To: UserRole
SessionKey
Type: string
Properties: Nillable
Description: The user’s unique session ID. Use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
SessionLevel
Type: picklist
Properties: Nillable, Restricted picklist
Description: Session-level security controls user access to features that support it, such as connected apps and reporting. Possible values are:
HIGH_ASSURANCE—A high assurance session was used for resource access. For example, when the user tries to access a resource such as a connected app, report, or dashboard that requires a high-assurance session level.
LOW—The user’s security level for the current session meets the lowest requirements.
STANDARD—The user’s security level for the current session meets the Standard requirements set in the org’s Session Security Levels.
This low level is not available, nor used, in the Salesforce UI. User sessions through the UI are either standard or high assurance. You can set this level using the API, but users assigned this level will experience unpredictable and reduced functionality in their Salesforce org.
Note
SourceIp
Type: string
Properties: Nillable
Description: The source IP address of the client logging in. For example, 126.7.4.2.
UserId
Type: reference
Properties: Nillable
Description: The user’s unique ID. For example, 005RM000001ctYJYAY. This is a polymorphic relationship field.
Relationship Name: User
Relationship Type: Lookup
Refers To: User
Username
Type: string
Properties: Nillable
Description: The username in the format of user@company.com at the time the event was created.
UserType
Type: picklist
Properties: Nillable, Restricted picklist
Description: The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. Valid values are:
CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
CspLitePortal—CSP Lite Portal license. Users whose access is limited because they are organization customers and access the application through a customer portal or an Experience Cloud site.
CustomerSuccess—Customer Success license. Users whose access is limited because they are organization customers and access the application through a customer portal.
Guest
PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they are organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
PowerPartner—Power Partner license. Users whose access is limited because they are partners and typically access the application through a partner portal or site.
SelfService
Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses.
j