Alerting tasks

Download AsyncAPI spec

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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

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

default = "com.qlik.v1.alerting-task.created"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

The unique identifier for the user triggering the event.
authtypestring

The type of principal that triggered the occurrence.
tenantidstring
Required

The unique identifier for the tenant related to the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
dataobject

Contains the event specific attributes of the payload.
Show data properties
- alertIDstring
  
  The identifier of the alert associated with the alerting task.
- creatorIdstring
  
  The identifier of the user who created the alerting task.
- accessTypestring
  
  The type of access associated with the alerting task.
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
- recipientsobject
  
  Show recipients properties
  
  userIdsarray of strings
  
  The list of user identifiers associated with the alerting task.
- conditionIdstring
  
  The identifier of the condition associated with the alerting task.
- triggerTypestring
  
  The type of trigger associated with the alerting task.
  
  Can be one of: "RELOAD""SCHEDULED""MANUAL"
- recipientsCountinteger
  
  The number of recipients associated with the alerting task.
- alertingTaskStatusstring
  
  The status of the alerting task.
- alertingTaskEnabledstring
  
  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",
    "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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.deleted"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

The unique identifier for the user triggering the event.
authtypestring

The type of principal that triggered the occurrence.
tenantidstring
Required

The unique identifier for the tenant related to the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
dataobject

Contains the event specific attributes of the payload.
Show data properties
- actionstring
  
  Action that triggered the deletion.
  
  Can be one of: "ADMIN_ACTION""OWNER_ACTION""APP_DELETED"
- alertIdstring
  
  ID of the alert.
- ownerIdstring
  
  ID of the owner of the alert.
- alertNamestring
  
  Name of the alert.
- descriptionstring
  
  Description of the alert.
- recipientIdsarray 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",
    "ownerId": "DRCy6BXc0O4AXNcFVPW-IPsUpbWCgRct",
    "alertName": "test4_new_alert_target_access_2_recipients_manual_trigger",
    "description": "test4_new_alert_target_access_2_recipients_manual_trigger",
    "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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.execution-summary.created"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

The unique identifier for the user triggering the event.
authtypestring

The type of principal that triggered the occurrence.
tenantidstring
Required

The unique identifier for the tenant related to the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
dataobject

Contains the event specific attributes of the payload.
Show data properties
- alertIdstring
  
  The identifier of the alert that the execution summary pertains to.
- summaryobject
  
  The execution summary data.
  
  Show summary properties
  
  alertIdstring
  
  The identifier of the alert that the execution summary pertains to.
  
  ownerIdstring
  
  The identifier of the owner of the alert.
  
  completeboolean
  
  Whether the execution summary is complete.
  
  tenantIdstring
  
  The identifier of the tenant that the alert belongs to.
  
  alertNamestring
  
  The name of the alert that the execution summary pertains to.
  
  accessModestring
  
  The access mode for the alert.
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
  
  workflowIdstring
  
  The identifier of the workflow that the alert belongs to.
  
  totalRecipientCountinteger
  
  The total number of recipients for the alert.
  
  failedExecutionsCountinteger
  
  The number of failed executions for the alert.
  
  disabledRecipientsCountinteger
  
  The number of disabled recipients for the alert.
  
  successfulExecutionsCountinteger
  
  The number of successful executions for the alert.
  
  failedExecutionsRecipientsInfoarray of objects
  
  Information about recipients for whom executions failed.
- trackingobject
  
  The tracking information for the event.
  
  Show tracking properties
  
  alertIdstring
  
  The identifier of the alert that the execution summary pertains to.
  
  workflowIdstring
  
  The identifier of the workflow that the execution summary pertains to.
- alertNamestring
  
  The name 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"
  }
}

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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.recipient.removed"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

The unique identifier for the user triggering the event.
authtypestring

The type of principal that triggered the occurrence.
tenantidstring
Required

The unique identifier for the tenant related to the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
dataobject

Contains the event specific attributes of the payload.
Show data properties
- alertIdstring
  
  The identifier of the alert the recipient was added to.
- ownerIdstring
  
  The identifier of the user who owns the alert.
- alertNamestring
  
  The name of the alert the recipient was added to.
- descriptionstring
  
  A description of the alert.
- recipientIdstring
  
  The identifier of the new 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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The unique identifier for the event type.

default = "com.qlik.v1.alerting-task.task-status.changed"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

The unique identifier for the user triggering the event.
authtypestring

The type of principal that triggered the occurrence.
tenantidstring
Required

The unique identifier for the tenant related to the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
dataobject

Contains the event specific attributes of the payload.
Show data properties
- causestring
  
  The cause of the alerting task status change.
- alertIdstring
  
  The identifier of the alert that the event pertains to.
- oldTaskobject
  
  The previous state of the alerting task.
  
  Show oldTask properties
  
  recipientsarray of objects
  
  Show recipients properties
  
  userIdstring
  
  userId of the recipient.
  
  subscribedboolean
  
  enabledByUserboolean
  
  Indicates whether the alerting task recipient was enabled by a user.
  
  enabledBySystemboolean
  
  Indicates whether the alerting task recipient was enabled by the system.
  
  alertingTaskRecipientErrorsarray of objects
  
  An array of error objects for the alerting task recipient.
  
  Show alertingTaskRecipientErrors properties
  
  valuestring
  
  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"
  
  enabledByUserboolean
  
  Indicates whether the alerting task was enabled by a user.
  
  enabledBySystemboolean
  
  Indicates whether the alerting task was enabled by the system.
  
  alertingTaskErrorsarray of objects
  
  An array of error objects for the alerting task.
  
  Show alertingTaskErrors properties
  
  valuestring
  
  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"
- ownerIdstring
  
  The identifier of the owner of the alerting task.
- tenantIdstring
  
  The identifier of the tenant of the alerting task.
- alertNamestring
  
  The name of the alert that the event pertains to.
- currentTaskobject
  
  The current state of the alerting task.
  
  Show currentTask properties
  
  recipientsarray of objects
  
  Show recipients properties
  
  userIdstring
  
  The identifier of the user associated with the alerting task recipient.
  
  subscribedboolean
  
  Indicates whether the alerting task recipient is subscribed to the alert.
  
  enabledByUserboolean
  
  Indicates whether the alerting task recipient was enabled by a user.
  
  enabledBySystemboolean
  
  Indicates whether the alerting task recipient was enabled by the system.
  
  alertingTaskRecipientErrorsarray of objects
  
  An array of error objects for the alerting task recipient.
  
  Show alertingTaskRecipientErrors properties
  
  valuestring
  
  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"
  
  enabledByUserboolean
  
  Indicates whether the alerting task was enabled by a user.
  
  enabledBySystemboolean
  
  Indicates whether the alerting task was enabled by the system.
  
  alertingTaskErrorsarray of objects
  
  An array of error objects for the alerting task.
  
  Show alertingTaskErrors properties
  
  valuestring
  
  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"
- descriptionstring
  
  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"
  }
}