Subscribing for Alerts¶
You can subscribe to events as a system administrator or as a API publisher/subscriber. These users can subscribe to any of the alert types listed in the Manage Alert Subscriptions page specific to them. For more information about different types of alerts and their importance, see Alert Types.
Info
Before you begin, make sure that you have done the following
- Configure Analytics for API Manager. For instructions, see Configuring APIM Analytics.
- Enable alerts in API-M Analytics. For instructions, see Enable alerts.
- Configure the sender email address in in API-M Analytics. For instructions, see Configure sender email alerts.
Subscribe to alerts¶
System Administrators¶
A system administrator is allowed to select one or more alert types to subscribe for, as well as specify a list of email addresses to which the alerts should be sent. Follow the procedure below to carry out the tasks mentioned above using the Admin Portal of WSO2 API Manager.
- Log into the WSO2 API Manager Admin Portal using the
https://<API-M_HOST>:<API-M_PORT>/admin
URL. - Click Manage Alerts to open the Manage Alert Subscriptions page.
- Select the relevant check boxes based on the alert types to which you want to subscribe.
- Under Email list , enter the list of email addresses that should receive alerts. The email addresses should be those of system administrators. Each email address can be separated with a comma or you can type Email address and press Enter.
- Click Save to save the information.
An API Manager publisher/subscriber can enable/disable alert types based on the alerts that he/she wants to receive individually, as well as specify a list of email addresses to which the alerts should be sent.
APIM Publisher/Subscriber¶
- Log into the API Publisher or API Developer Portal with the username and password of a user with required permission.
-
Click on the SETTINGS menu, to open the Manage Alert Subscriptions page.
-
API Publisher
-
API Developer Portal
-
-
Select the relevant check boxes based on the alert types to which you want to subscribe.
- Under Email list , enter the list of email addresses that should receive alerts.
- Click Save to save the information.
Unsubscribe to alerts¶
System Administrators¶
- Log into the WSO2 API Manager Admin Portal using the
https://<API-M_HOST>:<API-M_PORT>/admin
URL. - Click Manage Alerts to open the Manage Alert Subscriptions page.
- Deselect the relevant check boxes of the alert types to which you want to unsubscribe.
- Under Email list , remove the email addresses of users that should be removed from alerts recipient list.
- Click Save to save the information.
- Click Unsubscribe All to unsubscribe from all alert types.
APIM Publisher/Subscriber¶
- Log into the API Publisher or API Developer Portal with the username and password of a user with required permission.
-
Click on the SETTINGS menu, to open the Manage Alert Subscriptions page.
-
API Publisher
-
API Developer Portal
-
-
Deselect the relevant check boxes of the alert types to which you want to unsubscribe.
- Under Email list , remove the email addresses of users that should be removed from alerts recipient list.
- Click Save to save the information.
- Click Unsubscribe All to unsubscribe from all alert types.