ListViewEventStream (Beta)

Tracks actions related to list views in Salesforce Classic or the API. For example, the event captures when a user runs or exports a list view. It doesn’t capture list view events of Setup entities. This object is available in API version 45.0 and later.

This object is included in Real-Time Event Monitoring (Beta). As a beta feature, Real-Time Event Monitoring 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 this object in the Real-Time Event Monitoring Beta group in the Trailblazer Community.

Note

Supported Calls

describeSObjects()

Supported Subscribers

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

Streaming API Subscription Channel

/event/ListViewEventStream

Special Access Rules

Accessing this object requires the Shield Event Monitoring add-on, and the View Data Leakage Detection Events and API Enabled user permissions.

Fields

For some default list views, such as the list view that displays when a user clicks the Groups tab in Salesforce Classic, the DeveloperName, ListViewId, and Name fields are blank because the user didn’t explicitly create the list view.

Field	Details
AppName	Type string Properties Nillable Description Reserved for future use.
ColumnHeaders	Type string Properties Nillable Description Comma-separated values of column headers of the list view. These values are the API names, not the names shown in the UI. For example, `USERNAME, ACCOUNT.NAME, TYPE, DUE_DATE, LAST_UPDATE, ADDRESS1_STATE`.
DeveloperName	Type string Properties Nillable Description The unique name of the object in the API. This name contains only underscores and alphanumeric characters, and is unique in your org. If blank, the list view is a default list view (such as the list view that displays when a user clicks the Groups tab in Salesforce Classic) and not explicitly created by a user.
EvaluationTime	Type double Properties Nillable Description The amount of time it took to evaluate the transaction security policy, in milliseconds.
EventDate	Type dateTime Properties Filter, Sort Description The time when the specified list view event was captured. For example, `2013-01-01T03:01:01Z`. Seconds are the most granular setting.
EventIdentifier	Type string Properties Filter, Sort Description The unique ID of the event. For example, `4DWDVuDbwCDZcEIdp7MQZ`.
EventSource	Type string Properties Nillable, Restricted picklist Description The source of the event. Possible values are: `API`—The user generated the list view from an API call. `Classic`—The user generated the list view from a page in the Salesforce Classic UI. `Lightning`—Reserved for future use.
FilterCriteria	Type json Properties Nillable Description A JSON string that represents the list view’s filter criteria at the time the event was captured. Example Here’s a JSON string that represents filter criteria for an accounts list view. The list view shows only accounts of type “Prospect”. `1{"whereCondition": 2 {"type":"soqlCondition","field":"Type","operator":"equals","values":["'Prospect'"]} 3}`
ListViewData	Type json Properties Nillable Description A JSON string that represents the list view’s data. For example, `{"totalSize":1,"rows":[{"datacells":["005B0000001vURv","001B000000fewai"]}]}`.
ListViewId	Type reference Properties Nillable Description The ID of the list view associated with this event. If blank, the list view is a default list view (such as the list view that displays when a user clicks the Groups tab in Salesforce Classic) and not explicitly created by a user.
LoginHistoryId	Type reference Properties Nillable Description Tracks a user session so you can correlate user activity with a particular series of list view events. This field is also available in the LoginEvent, AuthSession, and LoginHistory objects, making it easier to trace events back to a user’s original authentication.
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.
Name	Type string Properties Nillable Description The display name of the list view. If blank, the list view is a default list view (such as the list view that displays when a user clicks the Groups tab in Salesforce Classic) and not explicitly created by a user.
NumberOfColumns	Type int Properties Nillable Description The number of columns in the list view.
OrderBy	Type string Properties Nillable Description The column that the list view is sorted by. For example, if a list view of accounts is sorted alphabetically by name, the OrderBy value is `[Name ASC NULLS FIRST, Id ASC NULLS FIRST]`. If the list is sorted alphabetically by type, the OrderBy value is `[Type ASC NULLS FIRST, Id ASC NULLS FIRST]`.
OwnerId	Type reference Properties Nillable Description The ID of the org or user who owns the list view. If the list view wasn’t saved, this value is the same as UserId.
PolicyId	Type reference Properties Nillable Description The ID of the transaction security policy associated with this event.
PolicyOutcome	Type picklist Properties Nillable, Restricted picklist Description The result of the transaction policy. Possible values are: `Block`—The user was blocked from performing the operation that triggered the policy. `EndSession`—The Concurrent Sessions Limiting policy activated, limiting the number of concurrent sessions per user. `Error`—The policy caused an undefined error when it executed. `FailedInvalidPassword`—The user entered an invalid password. `FailedPasswordLockout`—The user entered an invalid password too many times. `NoAction`—The policy didn't trigger. `Notified`—A notification was sent to the recipient. `TwoFAAutomatedSuccess`—Salesforce Authenticator approved the request for access because the request came from a trusted location. After users enable location services in Salesforce Authenticator, they can designate trusted locations. When a user trusts a location for a particular activity, such as logging in from a recognized device, that activity is approved from the trusted location for as long as the location is trusted. `TwoFADenied`—The user denied the approval request in the authenticator app, such as Salesforce Authenticator. `TwoFAFailedGeneralError`—An error caused by something other than an invalid verification code, too many verification attempts, or authenticator app connectivity. `TwoFAFailedInvalidCode`—The user provided an invalid verification code. `TwoFAFailedTooManyAttempts`—The user attempted to verify identity too many times. For example, the user entered an invalid verification code repeatedly. `TwoFAInitiated`—Salesforce initiated identity verification but hasn’t yet challenged the user. `TwoFAInProgress`—Salesforce challenged the user to verify identity and is waiting for the user to respond or for Salesforce Authenticator to send an automated response. `TwoFANoAction`—The policy specifies two factor authentication as an action, but the user is already in a high-assurance session. `TwoFARecoverableError`—Salesforce can’t reach the authenticator app to verify identity, but will retry. `TwoFAReportedDenied`—The user denied the approval request in the authenticator app, such as Salesforce Authenticator, and also flagged the approval request to report to an administrator. `TwoFASucceeded`—The user’s identity was verified.
QueriedEntities	Type string Properties Nillable Description The type of entities in the list view. For example, `Opportunity, Lead, Account,` or `Case`. Can also include custom objects. If no records are in the list view, then the value of this field is null.
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.
RowsProcessed	Type double Properties Nillable Description The total number of rows returned in the list view. When list data is divided into multiple list view events, this value is the same for all data chunks.
Scope	Type string Properties Nillable Description Represents the filter criteria for the list view. Possible values are: `Delegated`—Records delegated to another user for action; for example, a delegated task. `Everything`—All records, for example All Opportunities. `Mine`—Records owned by the user running the list view, for example My Opportunities. `MineAndMyGroups`—Records owned by the user running the list view, and records assigned to the user’s queues. `MyTerritory`—Records in the territory of the user seeing the list view. This option is available if territory management is enabled for your org. `MyTeamTerritory`—Records in the territory of the team of the user seeing the list view. This option is available if territory management is enabled for your org. `Queue`—Records assigned to a queue. `Team`—Records assigned to a team.
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. 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 `STANDARD`—The user’s security level for the current session meets the Standard requirements set in the org’s Session Security Levels.
SourceIp	Type string Properties Nillable Description The source IP address of the client that logged in. For example, `126.7.4.2`.
UserId	Type reference Properties Nillable Description The user’s unique ID. For example, `005000000000123`.
Username	Type string Properties Nillable Description The username in the format of `user@company.com` at the time the event was created.

Platform Events Developer Guide