Using Engagement to automate notification tasks

You can create complex workflows that automate tasks based on the specified criteria and enhances the overall API management experience by using the Engagement feature in the API Manager helps .

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 can be provisioned within a specific provider organization or catalog, enabling targeted access and management. Scheduled reports can also be created at cloud scope (Cloud Manager). To use Engagement, click Engagement icon on the Cloud Manager or API Manager and specify the criteria as required.

Within provider organizations and catalogs, users with appropriate permissions (engagement:view and engagement:manage) can create and manage engagement rules. At cloud scope, only scheduled reports are available.

Note: You can use Engagement only if there is at least one active analytics service and storage is enabled.

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
Note: The maximum number of rules that you can create per provider organization is 10, while the maximum number of rules that you can create across all analytics services within the organization is 10,000.

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

Scheduled reports

Use scheduled reports to automatically generate and deliver analytics reports on a recurring schedule. Scheduled reports provide a simple alternative to engagement rules when you need time-based report delivery without triggers and actions.

Scheduled Reports are particularly useful for:

  • Deliver regular operational summaries on a fixed schedule.
  • Generate daily, weekly, or monthly analytics reports.
  • Send reports automatically to management and stakeholders.
  • Run reports at cloud scope, where engagement rules are not supported.

For more information about Scheduled Reports, see Create scheduled reports.

Scheduled reports vs. engagement rules

Scheduled reports is a specialized feature within the broader Engagement capability. While both features deliver automated notifications, they serve different purposes:

Feature Scheduled Reports Engagement Rules
Purpose Deliver analytics reports on a recurring schedule Trigger notifications based on specific conditions and events
Triggers Time-based only (schedule) Event-based with conditions (triggers and filters)
Actions Report delivery Multiple actions per trigger
Cloud Scope Supported Not supported
Complexity Simple scheduled delivery Complex workflows with multiple triggers and actions