Alerting tasks

Download AsyncAPI spec

Alerting task events notify you about the execution of data alerts, including when alerts are triggered based on data conditions and when associated notifications are sent.

Published when a new data alert is created. Includes alert configuration, access type, recipients, and trigger settings. Use this to track alert creation and update external monitoring systems.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

Unique identifier for the event type. This event indicates that data alert has been created.

default = "com.qlik.v1.alerting-task.created"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

The unique identifier for the user triggering the event.
authtype string

The type of principal that triggered the occurrence.
tenantid string

Required

The unique identifier for the tenant related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Contains the event-specific attributes of the payload.
Show data properties
- alertID string
  
  The identifier of the alert associated with the alerting task.
- creatorId string
  
  The identifier of the user who created the alerting task.
- accessType string
  
  The type of access associated with the alerting task.
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
- recipients object
  
  Show recipients properties
  
  userIds array of strings
  
  The list of user identifiers associated with the alerting task.
- conditionId string
  
  The identifier of the condition associated with the alerting task.
- description string
  
  Description of the alert.
- triggerType string
  
  The type of trigger associated with the alerting task.
  
  Can be one of: "RELOAD""SCHEDULED"
- recipientsCount integer
  
  The number of recipients associated with the alerting task.
- alertingTaskStatus string
  
  The status of the alerting task.
- alertingTaskEnabled string
  
  Indicates whether the alerting task is enabled or not.

com.qlik.v1.alerting-task.created

Example payload of the "A data alert has been created" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.v1.alerting-task.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "User",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\n  \"sub\": \"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\n  \"email\": \"user@example.com\",\n  \"roles\": [\"admin\", \"editor\"]\n}\n",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "data": {
    "alertID": "string",
    "creatorId": "string",
    "accessType": "SOURCE_ACCESS",
    "recipients": {
      "userIds": [
        "string"
      ]
    },
    "conditionId": "string",
    "description": "string",
    "triggerType": "RELOAD",
    "recipientsCount": 42,
    "alertingTaskStatus": "string",
    "alertingTaskEnabled": "string"
  }
}

Published when a data alert is deleted. Includes the alert identifier, causal action code, and affected recipients. Use this to clean up alert subscriptions and external alert registries.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.deleted"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

The unique identifier for the user triggering the event.
authtype string

The type of principal that triggered the occurrence.
tenantid string

Required

The unique identifier for the tenant related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Contains the event-specific attributes of the payload.
Show data properties
- action string
  
  Action that triggered the deletion.
  
  Can be one of: "ADMIN_ACTION""OWNER_ACTION""APP_DELETED"
- alertId string
  
  ID of the alert.
- appName string
  
  Name of the app associated with the alerting task.
- ownerId string
  
  ID of the owner of the alert.
- alertName string
  
  Name of the alert.
- description string
  
  Description of the alert.
- triggerType string
  
  The type of trigger associated with the alerting task.
  
  Can be one of: "RELOAD""SCHEDULED"
- recipientIds array of strings
  
  IDs of the recipients of the alert.

com.qlik.v1.alerting-task.deleted

Example payload of the "A data alert has been deleted" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.v1.alerting-task.deleted",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "User",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\n  \"sub\": \"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\n  \"email\": \"user@example.com\",\n  \"roles\": [\"admin\", \"editor\"]\n}\n",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "data": {
    "action": "ADMIN_ACTION",
    "alertId": "64231b8989790dc11f0c88ee",
    "appName": "string",
    "ownerId": "DRCy6BXc0O4AXNcFVPW-IPsUpbWCgRct",
    "alertName": "test4_new_alert_target_access_2_recipients_manual_trigger",
    "description": "test4_new_alert_target_access_2_recipients_manual_trigger",
    "triggerType": "RELOAD",
    "recipientIds": [
      [
        "DRCy6BXc0O4AXNcFVPW-IPsUpbWCgRct",
        "2rQoqsyhuOH11bzP_tf8xD"
      ]
    ]
  }
}

Published when an execution summary is generated for a data alert. Includes execution statistics (successful, failed, disabled recipients), overall status, and tracking information. Use this to monitor alert execution health.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.execution-summary.created"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

The unique identifier for the user triggering the event.
authtype string

The type of principal that triggered the occurrence.
tenantid string

Required

The unique identifier for the tenant related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Contains the event-specific attributes of the payload.
Show data properties
- alertId string
  
  The identifier of the alert that the execution summary pertains to.
- summary object
  
  The execution summary data.
  
  Show summary properties
  
  alertId string
  
  The identifier of the alert that the execution summary pertains to.
  
  ownerId string
  
  The identifier of the owner of the alert.
  
  complete boolean
  
  Whether the execution summary is complete.
  
  tenantId string
  
  The identifier of the tenant that the alert belongs to.
  
  alertName string
  
  The name of the alert that the execution summary pertains to.
  
  accessMode string
  
  The access mode for the alert.
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
  
  workflowId string
  
  The identifier of the workflow that the alert belongs to.
  
  totalRecipientCount integer
  
  The total number of recipients for the alert.
  
  failedExecutionsCount integer
  
  The number of failed executions for the alert.
  
  disabledRecipientsCount integer
  
  The number of disabled recipients for the alert.
  
  successfulExecutionsCount integer
  
  The number of successful executions for the alert.
  
  failedExecutionsRecipientsInfo array of objects
  
  Information about recipients for whom executions failed.
- tracking object
  
  The tracking information for the event.
  
  Show tracking properties
  
  alertId string
  
  The identifier of the alert that the execution summary pertains to.
  
  workflowId string
  
  The identifier of the workflow that the execution summary pertains to.
- alertName string
  
  The name of the alert that the execution summary pertains to.
- description string
  
  The description of the alert that the execution summary pertains to.

com.qlik.v1.alerting-task.execution-summary.created

Example payload of the "A data alert execution summary has been generated" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.v1.alerting-task.execution-summary.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "User",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\n  \"sub\": \"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\n  \"email\": \"user@example.com\",\n  \"roles\": [\"admin\", \"editor\"]\n}\n",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "data": {
    "alertId": "62c5b42f53c0b193281aa124",
    "summary": {
      "alertId": "62c5b42f53c0b193281aa124",
      "ownerId": "4--qu5MTAghrqvygydtHSWTSqBWIiBtG",
      "complete": true,
      "tenantId": "ActoyXI9-8Z7H9M8W_JBbVAQvsOmBnle",
      "alertName": "New Terminal Alarm",
      "accessMode": "SOURCE_ACCESS",
      "workflowId": "24db23a7-6a2e-4a5f-8ee3-32fa1935f4f3",
      "totalRecipientCount": 1,
      "failedExecutionsCount": 0,
      "disabledRecipientsCount": 0,
      "successfulExecutionsCount": 1,
      "failedExecutionsRecipientsInfo": [
        {}
      ]
    },
    "tracking": {
      "alertId": "62c5b42f53c0b193281aa124",
      "workflowId": "62c5b42f53c0b193281aa124"
    },
    "alertName": "New Terminal Alarm",
    "description": "string"
  }
}

Published when a recipient is removed from a data alert. Includes the alert identifier, removed recipient, and alert metadata. Use this to revoke alert access.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.recipient.removed"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

The unique identifier for the user triggering the event.
authtype string

The type of principal that triggered the occurrence.
tenantid string

Required

The unique identifier for the tenant related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Contains the event-specific attributes of the payload.
Show data properties
- alertId string
  
  The identifier of the alert the recipient was removed from.
- ownerId string
  
  The identifier of the user who owns the alert.
- alertName string
  
  The name of the alert the recipient was removed from.
- description string
  
  A description of the alert.
- recipientId string
  
  The identifier of the recipient that was removed.

com.qlik.v1.alerting-task.recipient.removed

Example payload of the "A data alert has been modified by removing a recipient" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.v1.alerting-task.recipient.removed",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "User",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\n  \"sub\": \"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\n  \"email\": \"user@example.com\",\n  \"roles\": [\"admin\", \"editor\"]\n}\n",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "data": {
    "alertId": "64233273697940223c2f6993",
    "ownerId": "640239c20ae3db3eb09ffd55",
    "alertName": "test1_new_alert_source_access_2_recipients_manual_trigger",
    "description": "test1_new_alert_source_access_2_recipients_manual_trigger",
    "recipientId": "640239de63f7bc79e4f05915"
  }
}

Published when the operational status of a data alert changes (for example, enabled/disabled, error state). Includes the alert, current state, previous state, and cause of the change. Use this to track alert health and implement status-driven workflows.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.task-status.changed"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

The unique identifier for the user triggering the event.
authtype string

The type of principal that triggered the occurrence.
tenantid string

Required

The unique identifier for the tenant related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Contains the event-specific attributes of the payload.
Show data properties
- cause string
  
  The cause of the alerting task status change.
- alertId string
  
  The identifier of the alert that the event pertains to.
- oldTask object
  
  The previous state of the alerting task.
  
  Show oldTask properties
  
  recipients array of objects
  
  Show recipients properties
  
  userId string
  
  The identifier of the user associated with the alerting task recipient.
  
  subscribed boolean
  
  Indicates whether the alerting task recipient is subscribed to the alert.
  
  enabledByUser boolean
  
  Indicates whether the alerting task recipient was enabled by a user.
  
  enabledBySystem boolean
  
  Indicates whether the alerting task recipient was enabled by the system.
  
  alertingTaskRecipientErrors array of objects
  
  An array of error objects for the alerting task recipient.
  
  Show alertingTaskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on alerting task.
  
  Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"
  
  enabledByUser boolean
  
  Indicates whether the alerting task was enabled by a user.
  
  enabledBySystem boolean
  
  Indicates whether the alerting task was enabled by the system.
  
  alertingTaskErrors array of objects
  
  An array of error objects for the alerting task.
  
  Show alertingTaskErrors properties
  
  value string
  
  Identifier for type of error occurring on alerting task.
  
  Can be one of: "OWNER_DISABLED""OWNER_ACCESS""OWNER_LICENSE""APP_DELETED""NO_RECIPIENTS""PARTIAL_ACCESS""EVAL_ERROR""ORPHAN""CONVERSION_DENIED""EXPIRED""PARTIAL_SENT""QUOTA_REACHED"
- ownerId string
  
  The identifier of the owner of the alerting task.
- tenantId string
  
  The identifier of the tenant of the alerting task.
- alertName string
  
  The name of the alert that the event pertains to.
- currentTask object
  
  The current state of the alerting task.
  
  Show currentTask properties
  
  recipients array of objects
  
  Show recipients properties
  
  userId string
  
  The identifier of the user associated with the alerting task recipient.
  
  subscribed boolean
  
  Indicates whether the alerting task recipient is subscribed to the alert.
  
  enabledByUser boolean
  
  Indicates whether the alerting task recipient was enabled by a user.
  
  enabledBySystem boolean
  
  Indicates whether the alerting task recipient was enabled by the system.
  
  alertingTaskRecipientErrors array of objects
  
  An array of error objects for the alerting task recipient.
  
  Show alertingTaskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on alerting task.
  
  Can be one of: "USER_IS_DELETED""USER_DISABLED_IN_QCS""NO_ACCESS_TO_APP""UNSUBSCRIBED_FROM_ALERT""CONDITION_EVAL_ERROR""USER_DISABLED_IN_ALERT_BY_OWNER""MAX_ALERTS_LIMIT_REACHED"
  
  enabledByUser boolean
  
  Indicates whether the alerting task was enabled by a user.
  
  enabledBySystem boolean
  
  Indicates whether the alerting task was enabled by the system.
  
  alertingTaskErrors array of objects
  
  An array of error objects for the alerting task.
  
  Show alertingTaskErrors properties
  
  value string
  
  Identifier for type of error occurring on alerting task.
  
  Can be one of: "OWNER_DISABLED""OWNER_ACCESS""OWNER_LICENSE""APP_DELETED""NO_RECIPIENTS""PARTIAL_ACCESS""EVAL_ERROR""ORPHAN""CONVERSION_DENIED""EXPIRED""PARTIAL_SENT""QUOTA_REACHED"
- description string
  
  The description of the alerting task.

com.qlik.v1.alerting-task.task-status.changed

Example payload of the "A data alert status has been modified" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.v1.alerting-task.task-status.changed",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "User",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\n  \"sub\": \"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\n  \"email\": \"user@example.com\",\n  \"roles\": [\"admin\", \"editor\"]\n}\n",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "data": {
    "cause": "string",
    "alertId": "string",
    "oldTask": {
      "recipients": [
        {
          "userId": "string",
          "subscribed": true,
          "enabledByUser": true,
          "enabledBySystem": true,
          "alertingTaskRecipientErrors": [
            {
              "value": "USER_IS_DELETED"
            }
          ]
        }
      ],
      "enabledByUser": true,
      "enabledBySystem": true,
      "alertingTaskErrors": [
        {
          "value": "OWNER_DISABLED"
        }
      ]
    },
    "ownerId": "string",
    "tenantId": "string",
    "alertName": "string",
    "currentTask": {
      "recipients": [
        {
          "userId": "string",
          "subscribed": true,
          "enabledByUser": true,
          "enabledBySystem": true,
          "alertingTaskRecipientErrors": [
            {
              "value": "USER_IS_DELETED"
            }
          ]
        }
      ],
      "enabledByUser": true,
      "enabledBySystem": true,
      "alertingTaskErrors": [
        {
          "value": "OWNER_DISABLED"
        }
      ]
    },
    "description": "string"
  }
}