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.

Deprecation notice

These events are deprecated and will be removed on or after November 30, 2026.

Use the Web integrations events in the core namespace instead. For the full event mapping, see the deprecation notice.

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

Unique identifier for the event type.

default = "com.qlik.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.
tenantid string

Required

Unique identifier for the tenant related to the event.
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 hostname(s) associated with the tenant.

com.qlik.web-integration.created

Example payload of the "Web integration created" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.web-integration.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "UZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "id123",
    "name": "Api client 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

Unique identifier for the event type.

default = "com.qlik.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.
tenantid string

Required

Unique identifier for the tenant related to the event.
data object

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

com.qlik.web-integration.deleted

Example payload of the "Web integration deleted" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.web-integration.deleted",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "UZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "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

Unique identifier for the event type.

default = "com.qlik.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.
tenantid string

Required

Unique identifier for the tenant related to the event.
data object

Web integration details.
Show data properties
- id string
  
  Required
  
  Web integration identifier.
- updates array of objects
  
  Required
  
  Collection of updates performed on the resource.
  
  Show updates properties
  
  newValue string
  
  Value of the field after the update.
  
  oldValue string
  
  Value of the field before the update.
  
  property string
  
  Property that has changed.

com.qlik.web-integration.updated

Example payload of the "Web integration updated" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.web-integration.updated",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "UZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "id123",
    "updates": [
      {
        "newValue": "Web Integration 2",
        "oldValue": "Web Integration 1",
        "property": "name"
      }
    ]
  }
}