Environments

Download AsyncAPI spec

Environment events notify you about lifecycle changes to Qlik Cloud environments, including creation, deletion, and configuration updates.

Published when an environment is created in the tenant.

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

Unique identifier for the event type.

default = "com.qlik.v1.environment.created"
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
useridstring

Unique identifier for the user related to the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the created environment.
Show data properties
- idstring
  Required
  
  Identifier of the environment.
- namestring
  
  Name of the environment.
- tenantIdstring
  Required
  
  Identifier of the tenant the environment belongs to.
- createdAtstring
  Required
  
  Timestamp when the environment was created.
  
  format = "date-time"
- createdBystring
  
  Identifier of the user who created the environment.
- variablesarray of objects
  
  Key-value pairs.
  
  Show variables properties
  
  keystring
  
  Variable key.
  
  valuestring
  
  Variable value.
- descriptionstring
  
  Description of the environment.

com.qlik.v1.environment.created

Example payload of the "Environment created" event

{
  "id": "A234-1234-1234",
  "time": "2026-04-05T17:31:00Z",
  "type": "com.qlik.v1.environment.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "605a18af2ab08cdbfad09259",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Default environment",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2025-03-07T23:47:53Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "variables": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "description": "Default environment"
  }
}

Published when an environment is deleted from the tenant.

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

Unique identifier for the event type.

default = "com.qlik.v1.environment.deleted"
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
useridstring

Unique identifier for the user related to the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the deleted environment.
Show data properties
- idstring
  Required
  
  Identifier of the deleted environment.
- namestring

com.qlik.v1.environment.deleted

Example payload of the "Environment deleted" event

{
  "id": "A234-1234-1234",
  "time": "2026-04-05T17:31:00Z",
  "type": "com.qlik.v1.environment.deleted",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "605a18af2ab08cdbfad09259",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  }
}

Published when an environment is updated.

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

Unique identifier for the event type.

default = "com.qlik.v1.environment.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
useridstring

Unique identifier for the user related to the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the updated environment.
Show data properties
- idstring
  Required
  
  Identifier of the environment.
- namestring
  
  Name of the environment.
- createdAtstring
  
  Timestamp when the environment was created.
  
  format = "date-time"
- updatedAtstring
  Required
  
  Timestamp when the environment was updated.
  
  format = "date-time"
- updatedBystring
  
  Identifier of the user who updated the environment.
- variablesarray of objects
  
  Key-value pairs.
  
  Show variables properties
  
  keystring
  
  Variable key.
  
  valuestring
  
  Variable value.
- descriptionstring
  
  Description of the environment.

com.qlik.v1.environment.updated

Example payload of the "Environment updated" event

{
  "id": "A234-1234-1234",
  "time": "2026-04-05T17:31:00Z",
  "type": "com.qlik.v1.environment.updated",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "605a18af2ab08cdbfad09259",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Default environment",
    "createdAt": "2025-03-07T23:47:53Z",
    "updatedAt": "2025-03-07T23:47:53Z",
    "updatedBy": "00000000-0000-0000-0000-000000000000",
    "variables": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "description": "Default environment"
  }
}