dding the "isCritical" Jobstream Field to Subscription API Alert Payloads
search cancel

dding the "isCritical" Jobstream Field to Subscription API Alert Payloads

book

Article ID: 444014

calendar_today

Updated On:

Products

Automation Analytics & Intelligence

Issue/Introduction

When using the AAI Subscription Service to receive alert callbacks via REST webhooks, users observe the following:

  • The isCritical field is missing from the alert payload, even if the jobstream is marked as business-critical.
  • Custom notification templates cannot reference the jobstream’s criticality to pass it to downstream systems (e.g., ServiceNow, PagerDuty).
  • Programmatic queries to REST API alert endpoints do not return the criticality status for specific alerts.

Environment

Product: Automation Analytics & Intelligence (AAI) 

Component: Subscription Service / REST API 

Versions Affected: 24.4.0 and earlier

Cause

In AAI 24.4.0 and earlier versions, the isCritical property of a Jobstream was not published within the data payload sent to the Subscription Service. While the flag existed in the Jobstream definition, it was not exposed to the Alerting or Subscription frameworks.

Resolution

This issue is resolved in AAI Version 24.4.1 via defect DE183492.

After upgrading to AAI 24.4.1, the following enhancements are available:

  1. Webhook Payloads: REST webhook callbacks now include an isCritical (true/false) field.
  2. Notification Templates: Users can reference the field in custom templates using the syntax $.isCritical.
  3. REST API Endpoints: programmatically querying /jaws/rest/jobstreamruns/{runId}/alerts now includes the isCritical field for each alert.
  4. UI Visibility: The AAI Alerts table in the WebUI now displays the isCritical flag for each alert.

Additional Information

  • Historical Data: Alerts generated before the upgrade to 24.4.1 will show isCritical as null or absent. Only new alerts created post-upgrade will contain this metadata.
  • Other Channels: This enhancement specifically targets REST/Webhook subscriptions and the UI. It does not currently apply to SNMP trap variables or the standard email alert body.