Notification digests

Download AsyncAPI spec

A notification digest has been updated

Published when a notification digest configuration is updated. Includes frequency and enabled status. Use this to track digest configuration changes.

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.notification-digest.updated"

  • 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
    • enabledboolean

      Indicates if the notification digest is enabled or not.

    • frequencystring

      The frequency of the notification digest.

    • chronosJobIDstring

      The identifier of the Chronos job responsible for generating the notification digest.

com.qlik.notification-digest.updated

Example payload of the "A notification digest has been updated" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.notification-digest.updated",
  "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": {
    "enabled": true,
    "frequency": "string",
    "chronosJobID": "string"
  }
}