How to configure notifications and email templates in Azure API Management

API Management provides the ability to configure notifications for specific events, and to configure the email templates that are used to communicate with the administrators and developers of an API Management instance. This topic shows how to configure notifications for the available events, and provides an overview of configuring the email templates used for these events.

Configure publisher notifications

To configure notifications, click Publisher portal in the Azure Portal for your API Management service. This takes you to the API Management publisher portal.

Publisher portal

Note

If you have not yet created an API Management service instance, see Create an API Management service instance in the Get started with Azure API Management tutorial.

Click Notifications from the API Management menu on the left to view the available notifications.

Publisher notifications

The following list of events can be configured for notifications.

  • Subscription requests (requiring approval) - The specified email recipients and users will receive email notifications about subscription requests for API products requiring approval.
  • New subscriptions - The specified email recipients and users will receive email notifications about new API product subscriptions.
  • Application gallery requests - The specified email recipients and users will receive email notifications when new applications are submitted to the application gallery.
  • BCC - The specified email recipients and users will receive email blind carbon copies of all emails sent to developers.
  • New issue or comment - The specified email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.
  • Close account message - The specified email recipients and users will receive email notifications when an account is closed.
  • Approaching subscription quota limit - The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.

For each event, you can specify email recipients using the email address text box or you can select users from a list.

To specify the email addresses to be notified, enter them in the email address text box. If you have multiple email addresses, separate them using commas.

Notification recipients

To specify the users to be notified, click add recipient, check the box beside the users to be notified, and click OK.

Note

Only administrators are displayed in the list.

After configuring the notification recipients, click Save to apply the updated notification recipients.

Note

If you navigate away from the Publisher Notifications tab the publisher portal alerts you if there are unsaved changes.

Configure email templates

API Management provides email templates for the email messages that are sent in the course of administering and using the service. The following email templates are provided.

  • Application gallery submission approved
  • Developer farewell letter
  • Developer quota limit approaching notification
  • Invite user
  • New comment added to an issue
  • New issue received
  • New subscription activated
  • Subscription renewed confirmation
  • Subscription request declines
  • Subscription request received

These templates can be modified as desired.

To view and configure the email templates for your API Management instance, click Notifications from the API Management menu on the left, and select the Email Templates tab.

Email templates

To view or modify a specific template, select it from the Templates drop-down list.

Email templates list

Each email template has a subject in plain text, and a body definition in HTML format. Each item can be customized as desired.

Email template editor

The Parameters list contains a list of parameters, which when inserted into the subject or body, will be replaced the designated value when the email is sent. To insert a parameter, place the cursor where you wish the parameter to go, and click the arrow to the left of the parameter name.

Click Preview or Send a test to see how the email will look or send a test email.

Note

The parameters are not replaced with actual values when previewing or sending a test.

To save the changes to the email template, click Save, or to cancel the changes click Cancel.