Setting up notifications for an application

You can enable notifications for applications so that you are alerted when the usage of an API is nearing its rate limit. If you notice that an application is reaching its rate limit, you can take action such as changing the Plan to avoid impacting the users of your application.

About this task

You can control the frequency and method of receiving notifications that inform you when the usage of an API is approaching and exceeding the rate limit set on the Plan you selected.

You can view notifications from the built-in activity feed and by email with the option to turn off email notifications.

Note: If you have one or both of the following conditions, then you cannot receive notifications:
  • The API developer disabled the activity log policy for an operation.
  • The name of the rate limit in the Plan that you are subscribing to is not one of the names that is valid for the notifications to function; for more information, see Add a rate limit to your Plan.

Procedure

To set up notifications for an application, complete the following steps:

  1. Click Apps.
    The Apps page opens.
  2. Select the application that you want to work with.
  3. Click the Notifications tab.
    The notification settings page is displayed.
  4. Select the Enable notifications for this application check box.
  5. By default you always receive notifications when the rate limit is exceeded. If you want to be notified before the rate limit is exceeded, select one of the following options:
    • 50% of the Rate limit is reached
    • 75% of the Rate limit is reached
    • 90% of the Rate limit is reached
  6. Select how frequently you want to receive a notification from one of the following options.
    • Every minute
    • Every hour
    • Every day
    Note: You only receive one notification per operation per rate limit threshold within your chosen time interval. For example, if you choose Every hour and the 75% rate limit is reached twice, you are notified about it only once.
  7. After you enable notifications, you always receive them in the built-in activity feed. If you also want to receive notifications by email, select the Email check box.

Results

The notification settings for your application are defined.