Apps

Download AsyncAPI spec

Events emitted when Analytics apps are created, deleted, updated, exported, published, or reloaded in a Qlik Cloud tenant.

Choosing the right event for reload-related workflows

For most workflows that depend on the final result of a scheduled reload or a reload request started through the Reloads API, use com.qlik.v1.reload.finished from Reloads events instead of com.qlik.v1.app.reload.finished.

Use com.qlik.v1.app.reload.finished when you need to react to individual engine reload attempts.

Use com.qlik.v1.app.data.updated when your workflow depends on app data or app content being updated, rather than on the final status of a reload request.

An app was opened.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was opened.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- resourceType string
  
  App resource type.
- workloadType string
  
  Workload type.
- _resourcetype string Deprecated
  
  App resource type.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.v1.app.opened"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.v1.app.opened

Example payload of the "AppOpened" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "resourceType": "string",
    "workloadType": "string",
    "_resourcetype": "string"
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.v1.app.opened",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

A reload of an app was finished v1

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

A reload of an app was finished v1
Show data properties
- name string
  
  App name.
- size object
  
  Show size properties
  
  memory integer
  
  Data model size in memory (bytes).
  
  format = int64
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- errors array of undefineds Deprecated
  
  Reload errors. Max items 5.
- status string
  
  Reload status - error or ok.
- endTime string
  
  Time when reload ended.
  
  format = "date-time"
- duration integer
  
  Duration of reload (ms).
  
  format = int64
- reloadId string
  
  Reload identifier.
  
  format = "uuid"
- rowLimit integer
  
  If greater than or equal to 0, defines the maximum number of rows loaded from a data source.
  
  default = -1, format = int64, default = -1
- warnings array of undefineds Deprecated
  
  Reload warnings. Max items 5.
- statements array of undefineds Deprecated
  
  An empty list intended to hold script statements and their metadata. Use the Apps API to fetch reload metadata.
- isSkipStore boolean
  
  When true, store statements are not executed.
- isSessionApp boolean
  
  App is a Session app.
- isPartialReload boolean
  
  True if the reload is a partial reload.
- peakMemoryBytes integer
  
  Maximum number of bytes used during reload of the app.
  
  format = int64
- isDirectQueryMode boolean
  
  App is a Direct Query app
- endedWithMemoryConstraint boolean
  
  true if memory limits were exhausted during reload.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.v1.app.reload.finished"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.v1.app.reload.finished

Example payload of the "AppReloadFinished" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "name": "string",
    "size": {
      "memory": 42
    },
    "errors": [],
    "status": "string",
    "endTime": "2018-10-30T07:06:22Z",
    "duration": 42,
    "reloadId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "rowLimit": -1,
    "warnings": [],
    "statements": [],
    "isSkipStore": true,
    "isSessionApp": true,
    "isPartialReload": true,
    "peakMemoryBytes": 42,
    "isDirectQueryMode": true,
    "endedWithMemoryConstraint": true
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.v1.app.reload.finished",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

An app was created.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was created.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- size object
  
  Show size properties
  
  file integer
  
  Data model size on file (bytes).
  
  format = int64
  
  memory integer
  
  Data model size in memory (bytes).
  
  format = int64
- owner string Deprecated
  
  App owner.
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- custom object
  
  Contains dynamic JSON data specified by the client.
- ownerId string
  
  App owner identifier.
- spaceId string
  
  App space identifier.
  
  format = "uuid"
- published boolean
  
  When true, the app was distributed.
- thumbnail string
  
  App thumbnail.
- createdDate string
  
  Time when app was created.
  
  format = "date-time"
- description string
  
  App description.
- originAppId string
  
  Origin app identifier.
  
  format = "uuid"
- publishTime string
  
  Time when app was published.
  
  format = "date-time"
- dynamicColor string
  
  App dynamic color.
- modifiedDate string
  
  Time when app was last modified.
  
  format = "date-time"
- resourceType string
  
  App resource type.
- _resourcetype string Deprecated
  
  App resource type.
- lastReloadTime string
  
  Time of last successful reload.
  
  format = "date-time"
- createdByAction string
  
  Can be one of: "create""copy""publish""import""restore"
- hasSectionAccess boolean
  
  When true, the app has section access.
- isDirectQueryMode boolean
  
  When true, the app is a Direct Query app.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.created"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.created

Example payload of the "AppCreated" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "size": {
      "file": 42,
      "memory": 42
    },
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "resourceType": "string",
    "_resourcetype": "string",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.created",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

The data of an app was updated.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

The data of an app was updated.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- size object
  
  Show size properties
  
  file integer
  
  Data model size on file (bytes).
  
  format = int64
  
  memory integer
  
  Data model size in memory (bytes).
  
  format = int64
- spaceId string
  
  App space identifier.
  
  format = "uuid"
- _updates array of objects
  
  Show _updates properties
  
  path string
  
  Path to the updated value.
  
  newValue string
  
  Value after update.
  
  oldValue string
  
  Value before update.
- resourceType string
  
  App resource type.
- _resourcetype string Deprecated
  
  App resource type.
- lastReloadTime string
  
  Time of last successful reload.
  
  format = "date-time"
- lineageChanged boolean
  
  When true, there is new lineage information saved.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.data.updated"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.data.updated

Example payload of the "AppDataUpdated" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "size": {
      "file": 42,
      "memory": 42
    },
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "_updates": [
      {
        "path": "string",
        "newValue": "string",
        "oldValue": "string"
      }
    ],
    "resourceType": "string",
    "_resourcetype": "string",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "lineageChanged": true
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.data.updated",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

An app was deleted.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was deleted.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- spaceId string
  
  App space identifier.
  
  format = "uuid"
- deleteType string
  
  Can be one of: "SOFT""HARD"
- resourceType string
  
  App resource type.
- _resourcetype string Deprecated
  
  App resource type.
- isDirectQueryMode boolean
  
  When true, the app is a Direct Query app.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.deleted"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.deleted

Example payload of the "AppDeleted" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "resourceType": "string",
    "_resourcetype": "string",
    "isDirectQueryMode": true
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.deleted",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

An app was exported.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was exported.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- owner string Deprecated
  
  App owner.
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- custom object
  
  Contains dynamic JSON data specified by the client.
- ownerId string
  
  App owner.
- spaceId string
  
  Space identifier.
  
  format = "uuid"
- dataReduced boolean
  
  When true, data was reduced for smaller file size.
- dataExported boolean
  
  When true, data was exported.
- exportedDate string
  
  Time when app was exported.
  
  format = "date-time"
- resourceType string
  
  App resource type.
- _resourcetype string Deprecated
  
  App resource type.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.exported"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.exported

Example payload of the "AppExported" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "dataReduced": true,
    "dataExported": true,
    "exportedDate": "2018-10-30T07:06:22Z",
    "resourceType": "string",
    "_resourcetype": "string"
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.exported",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

An app was hard deleted and can no longer be restored.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was hard deleted and can no longer be restored.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- spaceId string
  
  App space identifier.
  
  format = "uuid"
- resourceType string
  
  App resource type.
- isDirectQueryMode boolean
  
  When true, the app is a Direct Query app.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.harddeleted"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.harddeleted

Example payload of the "AppHardDeleted" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "resourceType": "string",
    "isDirectQueryMode": true
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.harddeleted",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

An app was published.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was published.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- owner string Deprecated
  
  App owner.
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- custom object
  
  Contains dynamic JSON data specified by the client.
- spaceId string
  
  Space identifier.
  
  format = "uuid"
- originAppId string
  
  Origin app identifier.
  
  format = "uuid"
- resourceType string
  
  App resource type.
- _resourcetype string Deprecated
  
  App resource type.
- dataPublished boolean
  
  When true, data was published.
- originSpaceId string
  
  Origin space identifier.
  
  format = "uuid"
- publishedDate string
  
  Time when app was published.
  
  format = "date-time"
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.published"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.published

Example payload of the "AppPublished" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "owner": "string",
    "custom": {},
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "originAppId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "resourceType": "string",
    "_resourcetype": "string",
    "dataPublished": true,
    "originSpaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "publishedDate": "2018-10-30T07:06:22Z"
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.published",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}

An app was soft deleted and can still be restored.

Payload

object

id string

CloudEvent Identifier.

format = "uuid"
data object

An app was soft deleted and can still be restored.
Show data properties
- id string
  
  App identifier.
  
  format = "uuid"
- name string
  
  App name.
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- purgeAt string
  
  Earliest date the soft deleted app may be hard deleted (permanently purged). Once this date is reached, purge can happen at any time and is not under user control.
- spaceId string
  
  App space identifier.
  
  format = "uuid"
- resourceType string
  
  App resource type.
- isDirectQueryMode boolean
  
  When true, the app is a Direct Query app.
host string

Unique identifier for event producer.
time string

Time when event was sent.

format = "date"
type string

Event message name.

default = "com.qlik.app.softdeleted"
reason string

Reason for event.
source string

CloudEvent source Identifier.

default = "com.qlik/engine"
userid string

User Identifier.
ownerid string

Owner Identifier.
spaceid string

Space Identifier if resource is in a space.
authtype string

A string representing the type of principal that triggered the occurrence.
clientid string

OAuth-Client Identifier of the Event for OAuth token requests.
tenantid string

Tenant Identifier.
sessionid string

Session Identifier.
authclaims string

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

CloudEvents version.

default = "1.0"
datacontenttype string

CloudEvent content type.

default = "application/json"
toplevelresourceid string

Identifier of the top level resource

com.qlik.app.softdeleted

Example payload of the "AppSoftDeleted" event

{
  "id": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "name": "string",
    "purgeAt": "string",
    "spaceId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "resourceType": "string",
    "isDirectQueryMode": true
  },
  "host": "id",
  "time": "2022-10-30T07:06:22Z",
  "type": "com.qlik.app.softdeleted",
  "reason": "publishreplace",
  "source": "com.qlik/engine",
  "userid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "ownerid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "spaceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authtype": "service_account",
  "clientid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "tenantid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "sessionid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76",
  "authclaims": "{\"iss\":\"02_Open_App_V1\", \"sub\":\"7eddf8df-ce4f-4b94-9388-8d9e21b9ed75\", \"subType\":\"api-key\"}",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "toplevelresourceid": "ccb149fb-e2dd-420b-8d9f-e6aacb95eb76"
}