Context variables in the task payload
Use context variables to display the required task payload information.
You can use different context variables in the task payload to display information associated with the engagement alerts. When defining a rule for the notification task, you can add the required context variables in the task Payload section on the Define query page. The information corresponding to the context variables is displayed in the destination that is specified when creating or editing the rule. For more information, see Creating a notification task.
The following table shows the list of all context variables that are associated with the engagement alerts.
| Context variable | Description |
|---|---|
| catalogId | The catalog ID that the rules apply to. |
| endPeriod | The end of the time period. |
| field_name | To retrieve the field name used in filters. Follow the format {}{{field_name{}}}. For example, {}{{api_name{}}}, {}{{product_version{}}}. |
| filters | The list of filters that are used when creating the rules. |
| groupedData | The data grouped into buckets, each containing a key representing the following details:
|
| isRuleEnabled | Indicates whether the rule is enabled. |
| operator:field_name | To retrieve the operator used in filters. Follow the format {}{{operator:field_name{}}}. For example, {}{{operator:api_name{}}}, {}{{operator:product_version{}}}. |
| orgId | The organization ID that the rules apply to. |
| periodStart | The start of the time period. |
| ruleEnabledTime | The timestamp when the rule is enabled. |
| ruleLastUpdatedTime | The timestamp when the rule was last updated. |
| ruleName | The name of the rule that is created or updated. |
| ruleSchedulePeriodInterval | The interval for the rule schedule. |
| ruleSchedulePeriodUnit | The unit for the schedule period. |
| ruleType | The type of the rule. |
| searchIndex | The search index used to match the data. |
| totalDocumentsMatched | The total number of documents that match the rule conditions. |
| triggerCondition | The condition that is set to activate the trigger. |
| triggerId | The ID of the trigger associated with the rule. |
| triggerName | The name of the trigger associated with the rule. |
| triggerSeverity | The severity level of the trigger. |