Salesforce API Management: How to Monitor Salesforce API Usage - III

-

Looking for Salesforce Training & HandsOn Projects?


This is the third article of API Usage Monitoring Series. You can read the previous article here:

4. Using "API Usage Notifications"

Salesforce API Usage Notifications are email alerts that are sent to administrators when your organization's API usage exceeds a specified threshold. This can help you to stay on top of your API usage and avoid exceeding your organization's limits.

You can create up to 10 API Usage Notifications per organization.

You can create API Usage Notifications in Salesforce by going to Setup > API Usage Notifications. 

For example, if you set the threshold to 50% and the notification interval to 24 hours, you will receive an email notification if your organization's API usage exceeds 50% of its limit in the past 24 hours.

We can create API Usage Notifications as shown in the steps below:

Step-1: Go to Setup Search & find “api” search term

Step-2: Click on API Usage Notifications

Step-3: We will see the “All API Usage Notifications” page

Step-4: Click “New” to create a new notification. Notice we can create 10 notifications only. This is the limit enforced per Org


Step-5: Fill in the required details. You can specify the following settings for each notification:

  • Notification Recipient: The Salesforce user who will receive the notifications.
  • Threshold: The percentage of the rate limit that, once exceeded in the specified notification interval, triggers a notification to be sent to the specified user.
  • Notification interval (hours): The period for which the number of requests is measured, in hours.
Step-6: Click Save to save the notification definition

Step-7: We can all the notifications created using the List Page. Here we can review the key information about notifications in one place. Really a quick way to review multiple notification definitions at once.


There is more to this story, we will be having more articles explaining more tools available for API Monitoring. So stay tuned.

Hope you enjoyed this article. Please leave your comments to let me know how you like the content and how you find it helpful to learn the topic.

Trailblazer Profile | LinkedIn | Salesforce Blog | Facebook | Youtube Channel | WhatsApp Community







Comments

Post a Comment