Hub dashboards

Download AsyncAPI spec

Hub dashboard events notify you when customized home pages in activity centers are updated, including changes to personal and tenant-wide layouts. Customized home pages are a feature of the insights view in the Analytics activity center.

Dashboard updated

Published when a hub dashboard is updated. The event includes the dashboard ID, source (user for personal dashboards or tenant for tenant-wide dashboards), and a list of changed fields. Use this to keep external catalogs or monitoring systems up to date with dashboard 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 type of event related to the originating occurrence.

    default = "com.qlik.v1.hub-dashboard.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, default = "application/json"

  • useridstring

    Unique identifier for the user triggering the event.

  • updatesarray of objects

    List of resource updates describing the fields that changed. Note that this attribute is event-data-specific and is not a standard CloudEvents extension attribute; it is only populated for update events.

    Show updates properties
    • pathstring

      JSON pointer to the field that has been updated

    • newValueany

      The new value of the field. May be of any JSON type matching the underlying field (e.g. string, boolean, number, object, array or null).

    • oldValueany

      The value the field had before the update was applied. May be of any JSON type matching the underlying field (e.g. string, boolean, number, object, array or null).
  • authtypestring

    Representing the type of principal that triggered the occurrence.

  • tenantidstring
    Required

    Unique identifier for the tenant related to the event.

  • authclaimsstring

    JSON-encoded, whitelisted subset of the caller's auth claims (iss, sub, subType). sub is an opaque principal identifier (not a name or email), so this attribute does not carry PII.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required

    Dashboard specific data related to the event.

    Show data properties
    • idstring

      The unique identifier for the dashboard.

    • sourcestring

      The source of the dashboard. user is a user's personal dashboard. tenant is a tenant-wide dashboard configured by admins and curators.

      Can be one of: "user""tenant"

      default = "user"

    • updatedBystring

      userId of the user who last modified the dashboard

com.qlik.v1.hub-dashboard.updated

Example payload of the "Dashboard updated" event

{
  "id": "A234-1234-1234",
  "time": "2023-10-05T14:48:00.000Z",
  "type": "com.qlik.v1.hub-dashboard.updated",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "updates": [
    {
      "path": "string"
    }
  ],
  "authtype": "user",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\"iss\":\"https://qlik-trial.us.auth0.com/\",\"sub\":\"auth0|abc123\",\"subType\":\"user\"}",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "data": {
    "id": "5f4dcc3b5aa765d61d8327deb882cf99",
    "source": "user"
  }
}