Change stores

Download AsyncAPI spec

Change store events are sent when users save changes to a change store in Qlik Cloud. Change stores track modifications made through the Write table visualization.

Use these events to trigger downstream pipelines, sync external systems, or record modifications to change stores, instead of polling the Change stores API for updates.

Changes saved event for webhooks

Changes have been saved.

Payload

object
  • id string

    Unique identifier for the event.

  • time string

    Timestamp of when the event happened.

    format = "date-time"

  • type string

    The event type

    default = "com.qlik.analytics.change-store.changes.saved"

  • source string

    The source of the event.

    default = "com.qlik/write-table"

  • userid string

    Unique identifier for the user triggering the event.

  • tenantid string

    Unique identifier for the tenant related to the event.

  • specversion string

    The event is compatible with the CloudEvents specification v1.0

    Can be one of: "1.0"

  • datacontenttype string

    The content type of the event payload.

    default = "application/json"

  • data object

    The data payload for changes saved event.

    Show data properties
    • ownerId string

      The user that created the change-store. It is empty if the space is shared.

    • spaceId string

      The space that the change-store belongs to. It is empty if the space is personal.

    • storeId string

      The change-store unique identifier.

    • tenantId string

      The tenant where the change-store has been created.

    • createdBy string

      The user that saved the changes.

    • committedAt string

      The timestamp when the changes have been saved.

      format = "date-time"

com.qlik.analytics.change-store.changes.saved

Example payload of the "Changes saved event for webhooks" event

{
  "id": "id123",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.analytics.change-store.changes.saved",
  "source": "com.qlik/write-table",
  "userid": "id123",
  "tenantid": "id123",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "data": {
    "ownerId": "storeOwner1234",
    "spaceId": "space123",
    "storeId": "store012",
    "tenantId": "tenant123",
    "createdBy": "user345",
    "committedAt": "2024-01-01T12:20:00Z"
  }
}