Loading
Feature degradation | Gmail Email delivery failureRead More
Set Up and Maintain Your Salesforce Organization
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            ApiEvent Policies

            You are here:

            1. Salesforce Help
            2. Docs
            3. Set Up and Maintain Your Salesforce Organization

            ApiEvent Policies

            API events monitor API transactions, such as SOQL queries and data exports.

            Required Editions

            Available in both Salesforce Classic (not available in all orgs) and Lightning Experience.

            Available in: Enterprise, Unlimited, and Developer Editions

            Requires Salesforce Shield or Salesforce Event Monitoring add-on subscriptions.

            Policy at a Glance

            Object Conditions Available in Condition Builder Actions Considerations
            ApiEvent API Type, API Version, Application, Client, Elapsed Time, Operation, Platform, Queried Entities, Query, Rows Processed, Session Level, Source IP, User Agent, User ID, Username Block, Notifications Multi-factor authentication isn’t supported.

            What You Can Do With It

            You can monitor user behaviors taken through the API on a granular level. Create a policy that can:

            • Block access to particular versions of the API from specific platforms
            • Notify you when users run queries that return many rows

            Considerations for ApiEvent Policies

            • The supported SOAP, REST, Bulk API, and Bulk API 2.0 calls are query(), query_more(), and query_all(). Transaction Security supports only query(). API calls made from Visualforce (via an Apex controller) or XMLRPC aren’t supported in ApiEvent and ApiEventStream.
            • For Bulk API and Bulk API 2.0 queries, expect blank values for LoginHistoryId, Client, and UserAgent in ApiEvent. These queries are asynchronous and executed by a background job.
             
            Loading
            Salesforce Help | Article