Using Engagement to automate notification tasks

The Engagement feature in the API Manager helps the user to create complex workflows that automate tasks based on the specified criteria and enhances the overall API management experience.

Engagement allows external HTTP(S) endpoints to be triggered when specific criteria are met within the IBM® API Connect. This helps the user to create multiple complex workflows that automate tasks. The Engagement resources are provisioned within a specific provider organization or catalog, enabling targeted access and management. To use Engagement, click on the API Manager and specify the criteria as required.

Note: You can use Engagement only if there is one or more active analytics services.

You can specify the criteria as required, and a guided workflow facilitates the creation of rules. Each rule can have multiple triggers, which can be configured to run multiple actions that target specific destinations. When you configure rules and triggers, make sure to fulfill the following criteria:

  • Each rule can have up to 7 filter criteria and 5 triggers
  • Each trigger can have up to 3 actions

For more information on creating a notification task, see Creating a notification task.

Users can utilize Engagement on their API manager to receive notifications for various purposes. The following are some of the examples that show how users can use Engagement on their API Manager:
  • An API Provider can use Engagement to get notified:
    • If there are more than 3 HTTP 500 errors on any single API in any 24 hr period.
    • When the average response time for an API goes beyond a certain threshold.
  • A corporate security officer can use engagement to receive an email if someone accesses their banking APIs from an embargoed country.
  • An AI API Provider can use engagement to get notified if the total of the AI Tokens used within an hour goes beyond a certain threshold.