Benefits of API Usage Alerts

1. Customizable alerts: Users can create alerts tailored to their specific needs by providing the alert name, threshold limit, and recipient for the notifications.
2. Proactive monitoring: By setting up alerts, users can receive timely email notifications about their usage.
3. Effective resource management: Setting appropriate thresholds enables users to take necessary actions before reaching critical usage limits.
   

Accessing the API Usage Alerts

To access the API Usage Alerts

1. Click the Setup icon () in the top-right corner.
2. Under the Developer Space menu, click on API.
3. Under the API sub-menu, click the API Usage Alerts. 

1. When users access this feature for the first time, three default alerts for 80%, 90%, and 100% threshold limits are automatically configured. These alerts are designed to notify the primary contact and all agents in the support administrator profile whenever the specified threshold limits are reached. These alerts can be edited or deleted as needed. 
2. Details of the default rules creation will be recorded in the Audit Log. 
   

Creating a new alert 

1. Navigate to the API Usage Alerts page.
2. Click New Alert in the top-right corner.
   

1. Name: Enter the name of the alert. A maximum of 100 characters is allowed.
2. Description: Provide a detailed description of the alert. A maximum of 1500 characters is allowed.
3. Alert Threshold: Specify the threshold for triggering the email alert. The threshold must be between 50 and 100.
4. Email Template: The default template for the email that will be sent to the alert recipients.           

 The email template cannot be edited.   

1. Alert Recipients: Select the recipients of the alert. A maximum of 50 recipients can be configured.
   
1. You can choose recipients from the list of Agent, Profile, and Primary Contact configured within Zoho Desk. 
   
2. Additionally, you can also enter email addresses which are not configured in Zoho Desk.    
   

If users need to configure multiple agents, group those agents into a specific profile and configure that profile as the recipient.

Email addresses not configured in Zoho Desk will not be validated automatically, so users must ensure these addresses are valid before saving.

1. By default, an alert is created in the enabled state. To disable the alert, turn off the toggle switch.
2. Admin can create a maximum of five active alerts.

Editing an alert 

1. Scroll over the rule you want to edit and click on the edit symbol.
   

     

      2. A dialog box appears as shown below: 

          Edit the required fields.

      3. Click Save.

Deleting an alert 

1. Scroll over the rule you want to delete and click on the delete symbol.
   

Enabling or disabling the API Usage Alerts

1. Navigate to the API Usage Alerts page.
2. Click Enabled from the top-right corner. By default, the feature is enabled.