API Usage Alerts allows users to receive notifications when the usage of API meets a specified threshold. Users can create alerts by limiting the threshold value and selecting the recipients of those notifications. This ensures that when the threshold is reached, emails are sent to the intended recipients.
Availability
Permission Required
The API Usage Alerts is available in all paid editions.
Only users with Helpdesk Automation permission in their profile can access the API Usage Alerts.Benefits of API Usage Alerts
- Customizable alerts: Users can create alerts tailored to their specific needs by providing the alert name, threshold limit, and recipient for the notifications.
- Proactive monitoring: By setting up alerts, users can receive timely email notifications about their usage.
- 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
- Click the Setup icon (
) in the top-right corner. - Under the Developer Space menu, click on API.
- Under the API sub-menu, click the API Usage Alerts.
![](https://static.zohocdn.com/zoho-desk-editor/static/images/info.png)
- 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.
- Details of the default rules creation will be recorded in the Audit Log.
![](https://help.zoho.com/galleryDocuments/edbsn75c28a9c39f7edf8573c7f41ce15f8e01803e6740eda41b8889f5096059c7be58cde74494964a2b8fec95792fd5c2824?inline=true)
Creating a new alert
To create a new alert
- Navigate to the API Usage Alerts page.
- Click New Alert in the top-right corner.
3. A dialog box appears with the following fields:
![](https://help.zoho.com/galleryDocuments/edbsnd31a1a224b81f31fe1bc9a4fbde8387983858990efddaa04e0aad522ff34de14946079ba2ca9f565ebe3bd512f9e3d7c?inline=true)
- Name: Enter the name of the alert. A maximum of 100 characters is allowed.
- Description: Provide a detailed description of the alert. A maximum of 1500 characters is allowed.
- Alert Threshold: Specify the threshold for triggering the email alert. The threshold must be between 50 and 100.
- Email Template: The default template for the email that will be sent to the alert recipients.
![](https://static.zohocdn.com/zoho-desk-editor/static/images/file.png)
The email template cannot be edited.
- Alert Recipients: Select the recipients of the alert. A maximum of 50 recipients can be configured.
- You can choose recipients from the list of Agent, Profile, and Primary Contact configured within Zoho Desk.
- Additionally, you can also enter email addresses which are not configured in Zoho Desk.
![](https://static.zohocdn.com/zoho-desk-editor/static/images/info.png)
If users need to configure multiple agents, group those agents into a specific profile and configure that profile as the recipient.
![](https://static.zohocdn.com/zoho-desk-editor/static/images/caution.png)
Email addresses not configured in Zoho Desk will not be validated automatically, so users must ensure these addresses are valid before saving.
4. Click Save.
![](https://static.zohocdn.com/zoho-desk-editor/static/images/file.png)
- By default, an alert is created in the enabled state. To disable the alert, turn off the toggle switch.
- Admin can create a maximum of five active alerts.
Editing an alert
To edit an alert
- 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
To delete an alert
- Scroll over the rule you want to delete and click on the delete symbol.
Enabling or disabling the API Usage Alerts
To enable or disable API usage alerts
- Navigate to the API Usage Alerts page.
- Click Enabled from the top-right corner. By default, the feature is enabled.
3. To disable the feature, turn off the toggle switch.
![](https://static.zohocdn.com/zoho-desk-editor/static/images/file.png)
Disabling the feature will not turn off individual alerts in the UI. They will appear enabled but will remain inactive.