Web integrations

Download AsyncAPI spec

Web integration events notify you about changes to web integration configurations and CORS (Cross-Origin Resource Sharing) settings in your Qlik Cloud tenant.

Preferred events

These events replace the legacy Web integrations events. Use these events for all new implementations.

Published when a web integration is created.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

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

minLength = 1, format = "date-time"
type string

Required

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.web-integration.created"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

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

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Type of authentication context for the actor that triggered the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
sessionid string

Unique identifier for the session of the user triggering the event. Present only when a session identifier is available.
authclaims string

Serialized authentication claims for the actor that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

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

Web integration details.
Show data properties
- id string
  
  Required
  
  Web integration identifier.
- name string
  
  Required
  
  Web integration name.
- validOrigins array of strings
  
  Required
  
  List of valid origins (URLs) allowed to use the web integration for CORS requests.

com.qlik.core.web-integration.created

Example payload of the "Web integration created" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.core.web-integration.created",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "UZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "tenants",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "sessionid": "WZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\"sub\":\"auth0|abc123\",\"scope\":\"user_default\"}",
  "tracestate": "b3=00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "data": {
    "id": "id123",
    "name": "Web integration 1",
    "validOrigins": [
      "http://unicorn.com",
      "http://foo.example"
    ]
  }
}

Published when a web integration is deleted.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

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

minLength = 1, format = "date-time"
type string

Required

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.web-integration.deleted"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

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

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Type of authentication context for the actor that triggered the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
sessionid string

Unique identifier for the session of the user triggering the event. Present only when a session identifier is available.
authclaims string

Serialized authentication claims for the actor that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

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

Web integration details.
Show data properties
- id string
  
  Required
  
  Web integration identifier.

com.qlik.core.web-integration.deleted

Example payload of the "Web integration deleted" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.core.web-integration.deleted",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "UZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "tenants",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "sessionid": "WZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\"sub\":\"auth0|abc123\",\"scope\":\"user_default\"}",
  "tracestate": "b3=00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "data": {
    "id": "id123"
  }
}

Published when a web integration is updated.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

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

minLength = 1, format = "date-time"
type string

Required

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.web-integration.updated"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

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

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Type of authentication context for the actor that triggered the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
sessionid string

Unique identifier for the session of the user triggering the event. Present only when a session identifier is available.
authclaims string

Serialized authentication claims for the actor that triggered the event.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

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

Web integration details. Contains the full web integration object plus the list of updates that were applied.
Show data properties
- id string
  
  Required
  
  Web integration identifier.
- name string
  
  Web integration name.
- _updates array of objects
  
  Required
  
  Collection of updates performed on the resource.
  
  Show _updates properties
  
  path string
  
  JSON Pointer path of the property that has changed.
  
  newValue string|array
  
  Value of the field after the update. A string for scalar fields, or an array of strings for list fields such as validOrigins.
  
  One of:
  
  string
  
  array of strings
  
  oldValue string|array
  
  Value of the field before the update. A string for scalar fields, or an array of strings for list fields such as validOrigins.
  
  One of:
  
  string
  
  array of strings
- validOrigins array of strings
  
  List of valid origins (URLs) allowed to use the web integration for CORS requests.

com.qlik.core.web-integration.updated

Example payload of the "Web integration updated" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.core.web-integration.updated",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "UZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "tenants",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "sessionid": "WZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\"sub\":\"auth0|abc123\",\"scope\":\"user_default\"}",
  "tracestate": "b3=00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "data": {
    "id": "id123",
    "name": "Web integration 2",
    "_updates": [
      {
        "path": "/name",
        "newValue": "Web integration 2",
        "oldValue": "Web integration 1"
      }
    ],
    "validOrigins": [
      "http://unicorn.com"
    ]
  }
}