Qlik Component
Qlik is a business analytics platform. Use the Qlik component to manage your Data Sets, Assets, and Apps.
Component key: qlik · · Changelog ↓Description
Qlik is a business analytics platform. Use the Qlik component to manage your Data Sets, Assets, and Apps.
Connections
API Key
key: apiKeyAPI keys must first be enabled by an Admin:
- Login to Qlik and navigate to Settings> API Keys and enable API keys
Developer privileges must be given to users to use API keys:
- Navigate to the Management Console > Users > Edit Roles
- Check the box next to ‘Developer’ and save.
Generate API Keys:
- Navigate to Management Console > API Keys and select ‘Generate new key’
- provide a description and expiration and Save.
- Once the key is generated enter the value in to the connection's configuration.
| Input | Notes | Example |
|---|---|---|
| API Key | API Key for your Qlik User | |
| Tenant | The tenant of your Qlik account, the first part of your URL: v34wwyjhxohtob1.us.qlikcloud.com | v34wwyjhxohtob1 |
OAuth 2.0
key: oauth2To set up OAuth in Qlik:
- Login to Qlik and Navigate to Management Console > OAuth and select ‘Create New’
- Set ‘Web’ as the Client type and name the connection
- Enter
https://oauth2.prismatic.io/callbackto the ‘Add redirect URLs” field and select Add - Select ‘Create’ Qlik will generate the client ID and client secret.
- Transfer these values to the connection's configuration.
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for Qlik | https://<your-tenant>.us.qlikcloud.com/oauth/authorize |
| Client ID | Client Identifier of your app for Sage | |
| Client Secret | Client Secret of your app for Sage | |
| Scopes | Space separated OAuth 2.0 permission scopes for Sage | user_default online_access |
| Token URL | The OAuth 2.0 Token URL for Sage | https://<your-tenant>.us.qlikcloud.com/oauth/token |
Triggers
New and Updated Records
Checks for new and updated records in Qlik on a configured schedule. | key: pollChangesTrigger
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Resource Type | The type of Qlik resource to poll for changes. | |
| Show New Records | When enabled, newly created records will be included in the trigger output. | true |
| Show Updated Records | When enabled, records updated after the last poll will be included in the trigger output. | true |
The New and Updated Records trigger polls the Qlik API for new and updated records on a scheduled basis.
How It Works
- The trigger runs on the configured schedule
- On the first execution, the trigger records the current time and emits no records — historical data is not replayed on bootstrap
- On each subsequent run, the trigger fetches all records of the selected resource type and compares each record's created and updated timestamps against the last poll time
- Records are categorized as created when their created timestamp is later than the last poll time, or updated when only their updated timestamp is later
- The trigger persists the new poll time after each execution so the next run picks up where the previous run left off
Configuration
Configure the following inputs:
- Connection: The Qlik connection used to authenticate API requests
- Resource Type: The type of Qlik resource to monitor —
Spaces,Users,DataFiles, orDataStores - Show New Records: When enabled, includes newly created records in the trigger output. Defaults to
true - Show Updated Records: When enabled, includes records modified since the last poll in the trigger output. Defaults to
true
Returned Data
The trigger returns an object with two arrays — created for new records and updated for modified records since the previous poll.
Example Response
{
"data": {
"created": [
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"name": "Finance (dev)",
"type": "shared",
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"description": "Development space for Finance team applications"
}
],
"updated": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Marketing Space",
"type": "shared",
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
"createdAt": "2023-08-10T09:15:00Z",
"updatedAt": "2024-02-20T14:22:00Z",
"description": "Updated description for marketing assets"
}
]
}
}
Notes
- All four resource types —
Spaces,Users,DataFiles, andDataStores— support both new and updated record detection - The Qlik REST API does not expose server-side date filtering on these list endpoints, so all records are paginated client-side and timestamps are compared in the trigger after retrieval
Spaces,Users, andDataFilesuse cursor pagination vialinks.next.href;DataStoresuses offset pagination withpageandlimitparameters- Refer to the Qlik API documentation for rate limit details and available fields per resource type
Data Sources
Select App
Select an app from your Qlik account. | key: selectApp | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select App⤓
Select Data Asset
Select a data asset from your Qlik account. | key: selectDataAsset | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select Data Asset⤓
Select Data File
Select a data file from your Qlik account. | key: selectDataFile | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select Data File⤓
Select Data Set
Select a data set from your Qlik account. | key: selectDataSet | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select Data Set⤓
Select Data Store
Select a data store from your Qlik account. | key: selectDataStore | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select Data Store⤓
Select Space
Select a space from your Qlik account. | key: selectSpace | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select Space⤓
Select User
Select a user from your Qlik account. | key: selectUser | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Select User⤓
Actions
Create Data Asset
Save a new data asset. | key: createDataAssets
| Input | Notes | Example |
|---|---|---|
| App ID | The ID of the app you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| App Type | Type of the application | An App Type |
| Connection | ||
| Data Asset | The data asset to create or update. | |
| Technical Name | Technical name of the application | Some technical name |
Example Payload for Create Data Asset⤓
Create Data Store
Save a new data store. | key: createDataStore
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Store | The data store to create or update. | |
| Technical Name | Technical name of the data store | Some technical name |
| Type | The Type for the data store. | some-type |
| URI | The uri for the data store. | https://some-uri.com |
Example Payload for Create Data Store⤓
Create New Data Set
Save new data set. | key: createDataset
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Set | The data set to create or update. | |
| QRI | All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. | string<qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>> |
| Secure QRI | Secure QRI of the application | Some secure QRI |
| Technical Name | Technical name of the application | Some technical name |
Example Payload for Create New Data Set⤓
Create Report
Request a new report generation. | key: createReport
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Report | The report data to create. |
Example Payload for Create Report⤓
Create Space
Creates a space. | key: createSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space Description | The description of the space. Personal spaces do not have a description. | An attribute description. |
| Space Name | The name of the space. | An attribute name. |
| Type | The type of space such as shared, managed, and so on. | shared |
Example Payload for Create Space⤓
Delete App
Deletes a specific app. | key: deleteApp
| Input | Notes | Example |
|---|---|---|
| App ID | The ID of the app you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Connection |
Example Payload for Delete App⤓
Delete Data Assets
Batch delete data assets by IDs. | key: deleteDataAssets
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Asset IDs | The IDs of the data assets you would like to delete. |
Example Payload for Delete Data Assets⤓
Delete Data File
Deletes a specific Data File. | key: deleteDataFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data File ID | The id of the data file you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Delete Data File⤓
Delete Data Set
Delete data set by ID. | key: deleteDataset
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Set IDs | The IDs of the data sets you would like to delete. |
Example Payload for Delete Data Set⤓
Delete Data Stores
Batch delete data stores by IDs. | key: deleteDataStores
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Store IDs | The IDs of the data stores you would like to delete. |
Example Payload for Delete Data Stores⤓
Delete Data Stores Assets
Batch delete data stores by IDs. | key: deleteDataStoresAssets
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Asset IDs | The IDs of the data assets you would like to delete. | |
| Data Store IDs | The IDs of the data stores you would like to delete. |
Example Payload for Delete Data Stores Assets⤓
Delete Space
Deletes a space by ID. | key: deleteSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space ID | The ID of the space you would like to delete. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Delete Space⤓
Get App
Retrieves information for a specific app. | key: getApp
| Input | Notes | Example |
|---|---|---|
| App ID | The ID of the app you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Connection |
Example Payload for Get App⤓
Get Data Asset
Get data asset by ID. | key: getDataAssets
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Assets ID | The ID of the data set you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Projections | Fields name to return in the response. |
Example Payload for Get Data Asset⤓
Get Data File
Get descriptive info for the specified data file. | key: getDataFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data File ID | The id of the data file you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Get Data File⤓
Get Data Set
Get data set by ID. | key: getDataset
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Set ID | The ID of the data set you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Projections | Fields name to return in the response. |
Example Payload for Get Data Set⤓
Get Data Store
Get data store by ID. | key: getDataStore
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Store ID | The ID of the data store you would like to retrieve. | edaeaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Get Data Store⤓
Get My User
Redirects to retrieve the user resource associated with the JWT claims. | key: getMyUser
| Input | Notes | Example |
|---|---|---|
| Connection |
Example Payload for Get My User⤓
Get Report Request Status
Get report request processing status. | key: getReportRequestStatus
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Report ID | The ID of the report you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Get Report Request Status⤓
Get Space
Retrieves a single space by ID. | key: getSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space ID | The ID of the space you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Get Space⤓
List Data Files
Get all data files. | key: listDatafiles
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | If present, the maximum number of data files to return. | 20 |
| Page | If present, the cursor that starts the page of data that is returned. | asdasl123posidcs |
| Query Params | A list of params to send with the request. | appId=f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for List Data Files⤓
List Data Stores
Get all data stores. | key: listDataStores
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | If present, the maximum number of data files to return. | 20 |
| Page | If present, the cursor that starts the page of data that is returned. | asdasl123posidcs |
| Projections | Fields name to return in the response. | |
| Sort | Comma-separated fields and field start with '-' character sorts the result set in descending order. | name,-createdTime |
Example Payload for List Data Stores⤓
List Spaces
Get all Spaces. | key: listSpaces
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | If present, the maximum number of data files to return. | 20 |
| Query Params | A list of params to send with the request. | appId=f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Sort | Comma-separated fields and field start with '-' character sorts the result set in descending order. | name,-createdTime |
Example Payload for List Spaces⤓
List Users
Get all Users. | key: listUsers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | If present, the maximum number of data files to return. | 20 |
| Query Params | A list of params to send with the request. | appId=f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Sort | Comma-separated fields and field start with '-' character sorts the result set in descending order. | name,-createdTime |
Example Payload for List Users⤓
Raw Request
Send raw HTTP request to Qlik | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/employees), The base URL is already included (https://{tenant}.us.qlikcloud.com/api/v1). For example, to connect to https://{tenant}.us.qlikcloud.com/api/v1/employees, only /employees is entered in this field. | /employees |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Example Payload for Raw Request⤓
Update Data Asset
Update data asset by ID. | key: updateDataAssets
| Input | Notes | Example |
|---|---|---|
| App ID | The ID of the app you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| App Type | Type of the application | An App Type |
| Connection | ||
| Data Asset | The data asset to create or update. | |
| Data Assets ID | The ID of the data set you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Technical Name | Technical name of the application | Some technical name |
Example Payload for Update Data Asset⤓
Update Data Set
Update data set by ID. | key: updateDataset
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Set ID | The ID of the data set you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Data Set | The data set to create or update. | |
| QRI | All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. | string<qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>> |
| Secure QRI | Secure QRI of the application | Some secure QRI |
| Technical Name | Technical name of the application | Some technical name |
Example Payload for Update Data Set⤓
Update Data Store
Updates the information for a specific Data Store. | key: updateDataStore
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Store ID | The ID of the data store you would like to retrieve. | edaeaff0-faa1-41c4-a479-03ff004839dc |
| Data Store | The data store to create or update. | |
| Technical Name | Technical name of the data store | Some technical name |
| Type | The Type for the data store. | some-type |
| URI | The uri for the data store. | https://some-uri.com |
Example Payload for Update Data Store⤓
Updates Space
Updates a space. | key: updateSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Attribute Description | The description of the space. Personal spaces do not have a description. | An attribute description. |
| Attribute Name | The name of the space. | An attribute name. |
| Owner ID | The user ID of the space owner. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
| Space ID | The ID of the space you would like to retrieve. | f5ceaff0-faa1-41c4-a479-03ff004839dc |
Example Payload for Updates Space⤓
Changelog
2026-05-05
Added New and Updated Records polling trigger for monitoring Qlik resource changes:
- Supported Spaces, Users, Data Files, and Data Stores as selectable resource types
- Compatible with both API Key and OAuth 2.0 connections
- Emitted each new or updated record since the previous poll as a separate instance
2026-04-30
Updated spectral version
2026-04-07
Added global debug support across all actions for improved troubleshooting
2026-03-05
Added inline data sources for spaces, data stores, data files, users, datasets, data assets, and apps to enhance data selection capabilities