Skip to main content
Feedback

Managing Notification Emails

Notification emails are sent to developers when they register for a new key or when API calls reach or cross a specific limit. They can also be sent to notify developers about their API usage. Notification email templates are associated with API Plans, thereby allowing you to provide custom notifications to different API Plan users.

On the Notification Templates page, different template sets can be created to notify developers about different types of notifications. These template sets are assigned to Plans. Developers are categorized based on the contract they have with Cloud API Management. The different categories of developers can then be notified efficiently using these template sets.

The Notification Emails page shows the following fields for all the notification email templates created:

Email Template Set
The name of the email template set.

Plans Using
The number of plans that are using the template.

Last Modified
The date and time when the template set was last modified.

Adding Notification Email Template Set

Procedure

  1. Navigate to Design > Notification Templates. This opens the Notification Emails page.

  2. Click Add Template Set. This opens the Email Template Set: <name of your template> page. By default, the Over Throttle tab is selected.

  3. In Name, enter the name for the template set.

  4. Provide values for the following fields in the Over Throttle, Near Quota Limit, and Key Registration tabs:

    • Send "From" Address: Enter the email address. This email address will be used to send emails to developers.
    • Subject: Enter the subject name for the email.
    • Body: Enter the notification message for the email that developers will receive.

    The VARIABLES panel displays sample variables with brief descriptions of each, which can be used to create a template.

    tip

    • Click Clone Email Template Set: <name of your template> page to create an exact copy of the template set. The Clone option gets enabled after saving the newly created template

    • You can exit the template creation process at any time by clicking Cancel or Back to List to return to the Notifications Emails page.

  5. Click Save.

Deleting Notification Email Template Set

A template set can be permanently deleted. You can delete an email template set on the Email Template Set: <name of your template> page or the Notifications Emails page.

  • If deleting from the Email Template Set: <name of your template> page, then save the newly created template, and then click Delete.
  • If deleting from the Notifications Emails, then select the checkbox associated with the template set to enable the Delete Template Sets button, then click Delete Template Sets.
On this Page