Set up notifications

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation.

Monetization supports event notifications that enable you to:

  • Notify all developers about events such as new API products, versions of T&C's, or rate plans.
  • Notify specific developers about events such as when a new revision of a rate plan is published or a percentage of their target number of transactions is reached (if they purchased an adjustable notification rate plan).
  • Notify an API provider about developer-related events, such as when a developer registers for an account or when a developer purchases a rate plan.

Monetization provides the following methods for setting up notifications.

Method Description
Notification templates Monetization provides a set of notification templates that define sample text for various types of notifications. You customize the notification templates and configure the conditions that trigger the notifications to be sent.
Webhooks A webhook defines an HTTP callback handler that is triggered by an event. You can create webhooks and configure them to handle event notifications.

The following table summarizes additional tasks that you can perform to set up and test notifications using the monetization API.

Section Description
Set up notifications based on combined transaction totals for a company and its developers (API only) Set up notifications to be sent that are based on combined transaction totals for the company and its developers.
Set up a limit notification for a rate plan (API only) Notify developers through email when they're nearing or have reached a certain limit of a Volume Banded or Bundle rate card plan they've purchased.
Test notification setup (API only) Monetization provides a set of APIs that you can use to test your notification setup.