Webhooks

Webhooks are a way for Qlik Cloud to provide other applications with real-time information.

Endpoints

GET

/api/v1/webhooks
POST

/api/v1/webhooks
GET

/api/v1/webhooks/{id}
PATCH

/api/v1/webhooks/{id}
PUT

/api/v1/webhooks/{id}
DELETE

/api/v1/webhooks/{id}
GET

/api/v1/webhooks/{id}/deliveries
GET

/api/v1/webhooks/{id}/deliveries/{deliveryId}
POST

/api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resend
GET

/api/v1/webhooks/event-types

Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the TenantAdmin role can retrieve all webhooks. A user can have up to 150 webhooks at one time.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

createdByUserId string

Filter resources by user that created it.
enabled boolean

Filter resources by enabled true/false.
eventTypes string

Filter resources by event-type/types, a single webhook item can have multiple event-types.
level string

Filter resources by level that user has access to (either user or level).
limit number

Maximum number of webhooks to retrieve.

minimum = 1, maximum = 100, default = 20, default = 20
name string

Filter resources by name (wildcard and case insensitive).
next string

Cursor to the next page.
origins string

Filter resources by origins, supports multiorigin.

Can be one of: "api""automations""management-console"
ownerId string

Filter resources by user that owns it, only applicable for user level webhooks.
prev string

Cursor to the previous page.
sort string

Field to sort by, prefix with -/+ to indicate order.

Can be one of: "name""+name""-name""url""+url""-url""createdAt""+createdAt""-createdAt""updatedAt""+updatedAt""-updatedAt"
default = "-createdAt"
updatedByUserId string

Filter resources by user that last updated the webhook.
url string

Filter resources by URL (wildcard and case insensitive).

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  The webhook's unique identifier.
  
  url string
  
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
  
  name string
  
  Required
  
  The name for the webhook.
  
  maxLength = 512
  
  level string
  
  Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator.
  
  Can be one of: "tenant""user"
  default = "tenant"
  
  filter string
  
  Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation.
  
  enabled boolean
  
  Whether the webhook is active and sending requests.
  
  default = false
  
  headers object
  
  Additional headers in the post request. Maximum size: 2048 bytes for non-encrypted headers.
  
  Show additional optional properties
  
  string string
  
  ownerId string
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
  
  createdAt string
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
  
  eventTypes array of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
  
  description string
  
  The reason for creating the webhook.
  
  maxLength = 1024
  
  disabledReason string
  
  The reason for the webhook to be disabled.
  
  secretKeyAdded boolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
  
  createdByUserId string
  
  The id of the user that created the webhook.
  
  updatedByUserId string
  
  The id of the user that last updated the webhook.
  
  encryptedHeaders array of strings
  
  Additional encrypted headers in the post request. Maximum size: 2048 bytes for encrypted headers.
  
  disabledReasonCode string
  
  The unique code for the reason.
  
  enableCloudEventDelivery boolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
  
  checkCertificateRevocation boolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
  
  origin string
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  default = "api"
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL to a resource request.
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL to a resource request.
  
  self object
  
  Show self properties
  
  href string
  
  Required
  
  URL to a resource request.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/webhooks

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhooks({})

qlik webhook ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "url": "string",
      "name": "string",
      "level": "tenant",
      "filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\" or topLevelResourceId eq \"id789\"",
      "enabled": false,
      "headers": {
        "headerName": "headerValue"
      },
      "ownerId": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "updatedAt": "2018-10-30T07:06:22Z",
      "eventTypes": [
        "string"
      ],
      "description": "string",
      "disabledReason": "string",
      "secretKeyAdded": true,
      "createdByUserId": "string",
      "updatedByUserId": "string",
      "encryptedHeaders": [
        "header1",
        "header2"
      ],
      "disabledReasonCode": "string",
      "enableCloudEventDelivery": true,
      "checkCertificateRevocation": false,
      "origin": "api"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new webhook. User must be assigned the TenantAdmin role to create tenant level webhooks.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/json object
Show application/json properties
- url string
  
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- name string
  
  Required
  
  The name for the webhook.
  
  maxLength = 512
- level string
  
  Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator.
  
  Can be one of: "tenant""user"
  default = "tenant"
- filter string
  
  Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation.
- secret string
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabled boolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headers object
  
  Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. Maximum size: 2048 bytes for non-encrypted headers.
  
  Show additional optional properties
  
  string string
- ownerId string
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- eventTypes array of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- description string
  
  The reason for creating the webhook.
  
  maxLength = 1024
- encryptedHeaders object
  
  These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive. Maximum size: 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
- enableCloudEventDelivery boolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocation boolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- origin string
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  default = "api"

Responses

201

OK Response

application/json object
Show application/json properties
- id string
  
  The webhook's unique identifier.
- url string
  
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- name string
  
  Required
  
  The name for the webhook.
  
  maxLength = 512
- level string
  
  Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator.
  
  Can be one of: "tenant""user"
  default = "tenant"
- filter string
  
  Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation.
- enabled boolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headers object
  
  Additional headers in the post request. Maximum size: 2048 bytes for non-encrypted headers.
  
  Show additional optional properties
  
  string string
- ownerId string
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- createdAt string
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
- updatedAt string
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
- eventTypes array of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- description string
  
  The reason for creating the webhook.
  
  maxLength = 1024
- disabledReason string
  
  The reason for the webhook to be disabled.
- secretKeyAdded boolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
- createdByUserId string
  
  The id of the user that created the webhook.
- updatedByUserId string
  
  The id of the user that last updated the webhook.
- encryptedHeaders array of strings
  
  Additional encrypted headers in the post request. Maximum size: 2048 bytes for encrypted headers.
- disabledReasonCode string
  
  The unique code for the reason.
- enableCloudEventDelivery boolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocation boolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- origin string
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  default = "api"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/webhooks

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.createWebhook({
  description: 'string',
  enableCloudEventDelivery: true,
  encryptedHeaders: {
    headerName: 'sensitiveHeaderValue',
  },
  eventTypes: ['string'],
  filter:
    'id eq "id123" or spaceId eq "spaceId123" or spaceId eq "spaceId456" or topLevelResourceId eq "id789"',
  headers: { headerName: 'headerValue' },
  level: 'tenant',
  name: 'string',
  ownerId: 'string',
  secret: 'string',
  url: 'string',
  origin: 'api',
})

qlik webhook create \
  --name 'string' \
  --url 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"url":"string","name":"string","level":"tenant","filter":"id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\" or topLevelResourceId eq \"id789\"","secret":"string","enabled":false,"headers":{"headerName":"headerValue"},"ownerId":"string","eventTypes":["string"],"description":"string","encryptedHeaders":{"headerName":"sensitiveHeaderValue"},"enableCloudEventDelivery":true,"checkCertificateRevocation":false,"origin":"api"}'

Example Response

{
  "id": "string",
  "url": "string",
  "name": "string",
  "level": "tenant",
  "filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\" or topLevelResourceId eq \"id789\"",
  "enabled": false,
  "headers": {
    "headerName": "headerValue"
  },
  "ownerId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "eventTypes": [
    "string"
  ],
  "description": "string",
  "disabledReason": "string",
  "secretKeyAdded": true,
  "createdByUserId": "string",
  "updatedByUserId": "string",
  "encryptedHeaders": [
    "header1",
    "header2"
  ],
  "disabledReasonCode": "string",
  "enableCloudEventDelivery": true,
  "checkCertificateRevocation": false,
  "origin": "api"
}

Returns details for a specific webhook.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

id string

Required

The webhook's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The webhook's unique identifier.
- url string
  
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- name string
  
  Required
  
  The name for the webhook.
  
  maxLength = 512
- level string
  
  Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator.
  
  Can be one of: "tenant""user"
  default = "tenant"
- filter string
  
  Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation.
- enabled boolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headers object
  
  Additional headers in the post request. Maximum size: 2048 bytes for non-encrypted headers.
  
  Show additional optional properties
  
  string string
- ownerId string
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- createdAt string
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
- updatedAt string
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
- eventTypes array of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- description string
  
  The reason for creating the webhook.
  
  maxLength = 1024
- disabledReason string
  
  The reason for the webhook to be disabled.
- secretKeyAdded boolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
- createdByUserId string
  
  The id of the user that created the webhook.
- updatedByUserId string
  
  The id of the user that last updated the webhook.
- encryptedHeaders array of strings
  
  Additional encrypted headers in the post request. Maximum size: 2048 bytes for encrypted headers.
- disabledReasonCode string
  
  The unique code for the reason.
- enableCloudEventDelivery boolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocation boolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- origin string
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  default = "api"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/webhooks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhook('string')

qlik webhook get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "url": "string",
  "name": "string",
  "level": "tenant",
  "filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\" or topLevelResourceId eq \"id789\"",
  "enabled": false,
  "headers": {
    "headerName": "headerValue"
  },
  "ownerId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "eventTypes": [
    "string"
  ],
  "description": "string",
  "disabledReason": "string",
  "secretKeyAdded": true,
  "createdByUserId": "string",
  "updatedByUserId": "string",
  "encryptedHeaders": [
    "header1",
    "header2"
  ],
  "disabledReasonCode": "string",
  "enableCloudEventDelivery": true,
  "checkCertificateRevocation": false,
  "origin": "api"
}

Patches a webhook to update one or more properties.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

id string

Required

The webhook's unique identifier.

Request Body

Required

application/json array of objects

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902
Show application/json properties
- op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "add""remove""replace"
- path string
  
  Required
  
  The path for the given resource field to patch.
  
  Can be one of: "/name""/description""/url""/eventTypes""/headers""/enabled""/secret""/encryptedHeaders""/enableCloudEventDelivery"
- value boolean|integer|object|string
  
  The value to be used for this operation.
  
  One of:
  
  boolean
  
  integer
  
  object
  
  string

Responses

204

No Content response.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

PATCH /api/v1/webhooks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.patchWebhook('string', [
  {
    op: 'add',
    path: '/description',
    value: true,
  },
])

qlik webhook patch 'string' \
  --op 'add' \
  --path '/description'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","path":"/description","value":true}]'

Updates a webhook, any omitted fields will be cleared, returns updated webhook.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

id string

Required

The webhook's unique identifier.

Request Body

Required

application/json object
Show application/json properties
- url string
  
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- name string
  
  Required
  
  The name for the webhook.
  
  maxLength = 512
- level string
  
  Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator.
  
  Can be one of: "tenant""user"
  default = "tenant"
- filter string
  
  Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation.
- secret string
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabled boolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headers object
  
  Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. Maximum size: 2048 bytes for non-encrypted headers.
  
  Show additional optional properties
  
  string string
- ownerId string
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- eventTypes array of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- description string
  
  The reason for creating the webhook.
  
  maxLength = 1024
- encryptedHeaders object
  
  These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive. Maximum size: 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
- enableCloudEventDelivery boolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocation boolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The webhook's unique identifier.
- url string
  
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- name string
  
  Required
  
  The name for the webhook.
  
  maxLength = 512
- level string
  
  Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator.
  
  Can be one of: "tenant""user"
  default = "tenant"
- filter string
  
  Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation.
- enabled boolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headers object
  
  Additional headers in the post request. Maximum size: 2048 bytes for non-encrypted headers.
  
  Show additional optional properties
  
  string string
- ownerId string
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- createdAt string
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
- updatedAt string
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
- eventTypes array of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- description string
  
  The reason for creating the webhook.
  
  maxLength = 1024
- disabledReason string
  
  The reason for the webhook to be disabled.
- secretKeyAdded boolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
- createdByUserId string
  
  The id of the user that created the webhook.
- updatedByUserId string
  
  The id of the user that last updated the webhook.
- encryptedHeaders array of strings
  
  Additional encrypted headers in the post request. Maximum size: 2048 bytes for encrypted headers.
- disabledReasonCode string
  
  The unique code for the reason.
- enableCloudEventDelivery boolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocation boolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- origin string
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  default = "api"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

PUT /api/v1/webhooks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.updateWebhook('string', {
  description: 'string',
  enableCloudEventDelivery: true,
  encryptedHeaders: {
    headerName: 'sensitiveHeaderValue',
  },
  eventTypes: ['string'],
  filter:
    'id eq "id123" or spaceId eq "spaceId123" or spaceId eq "spaceId456" or topLevelResourceId eq "id789"',
  headers: { headerName: 'headerValue' },
  level: 'tenant',
  name: 'string',
  ownerId: 'string',
  secret: 'string',
  url: 'string',
})

qlik webhook update 'string' \
  --name 'string' \
  --url 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"url":"string","name":"string","level":"tenant","filter":"id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\" or topLevelResourceId eq \"id789\"","secret":"string","enabled":false,"headers":{"headerName":"headerValue"},"ownerId":"string","eventTypes":["string"],"description":"string","encryptedHeaders":{"headerName":"sensitiveHeaderValue"},"enableCloudEventDelivery":true,"checkCertificateRevocation":false}'

Example Response

{
  "id": "string",
  "url": "string",
  "name": "string",
  "level": "tenant",
  "filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\" or topLevelResourceId eq \"id789\"",
  "enabled": false,
  "headers": {
    "headerName": "headerValue"
  },
  "ownerId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "eventTypes": [
    "string"
  ],
  "description": "string",
  "disabledReason": "string",
  "secretKeyAdded": true,
  "createdByUserId": "string",
  "updatedByUserId": "string",
  "encryptedHeaders": [
    "header1",
    "header2"
  ],
  "disabledReasonCode": "string",
  "enableCloudEventDelivery": true,
  "checkCertificateRevocation": false,
  "origin": "api"
}

Deletes a specific webhook.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

id string

Required

The webhook's unique identifier.

Responses

204

No Content response.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

DELETE /api/v1/webhooks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.deleteWebhook('string')

qlik webhook rm 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Returns deliveries for a specific webhook. Delivery history is stored for 1 week.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

eventType string

Filter resources by event-type.
limit number

Maximum number of deliveries to retrieve.

minimum = 1, maximum = 100, default = 20, default = 20
next string

Cursor to the next page.
prev string

Cursor to the previous page.
sort string

Field to sort by, prefix with -/+ to indicate order.

Can be one of: "status""+status""-status""triggeredAt""+triggeredAt""-triggeredAt"
default = "-triggeredAt"
status string

Filter resources by status (success or fail).

Can be one of: "success""fail"

Path Parameters

id string

Required

The webhook's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Required
  
  The delivery's unique identifier.
  
  status string
  
  Required
  
  The status of delivery.
  
  Can be one of: "success""fail"
  
  request object
  
  Request details for the delivery.
  
  Show request properties
  
  url string
  
  URL used for this delivery.
  
  body object
  
  The sent body/payload of the delivery.
  
  headers object
  
  Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
  
  response object
  
  Response details for the delivery.
  
  Show response properties
  
  body string
  
  The received body of the delivery.
  
  headers object
  
  Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
  
  statusCode number
  
  The HTTP status code of the response.
  
  eventType string
  
  Required
  
  The name of the triggering event-type.
  
  webhookId string
  
  Required
  
  The unique webhook identifier that the delivery is for.
  
  triggeredAt string
  
  Required
  
  The UTC timestamp when the delivery was triggered.
  
  format = "date-time"
  
  statusMessage string
  
  The status message of the delivery.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL to a resource request.
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL to a resource request.
  
  self object
  
  Show self properties
  
  href string
  
  Required
  
  URL to a resource request.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/webhooks/{id}/deliveries

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhookDeliveries(
  'string',
  {},
)

qlik webhook delivery ls \
  --webhookId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}/deliveries" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "status": "success",
      "request": {
        "url": "string",
        "body": {},
        "headers": {
          "headerName": "headerValue",
          "encryptedHeadersName": "**OMITTED**"
        }
      },
      "response": {
        "body": "string",
        "headers": {
          "headerName": "headerValue",
          "encryptedHeadersName": "**OMITTED**"
        },
        "statusCode": 42
      },
      "eventType": "string",
      "webhookId": "string",
      "triggeredAt": "2018-10-30T07:06:22Z",
      "statusMessage": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Returns details for a specific delivery.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

deliveryId string

Required

The delivery's unique identifier.
id string

Required

The webhook's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  Required
  
  The delivery's unique identifier.
- status string
  
  Required
  
  The status of delivery.
  
  Can be one of: "success""fail"
- request object
  
  Request details for the delivery.
  
  Show request properties
  
  url string
  
  URL used for this delivery.
  
  body object
  
  The sent body/payload of the delivery.
  
  headers object
  
  Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
- response object
  
  Response details for the delivery.
  
  Show response properties
  
  body string
  
  The received body of the delivery.
  
  headers object
  
  Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
  
  statusCode number
  
  The HTTP status code of the response.
- eventType string
  
  Required
  
  The name of the triggering event-type.
- webhookId string
  
  Required
  
  The unique webhook identifier that the delivery is for.
- triggeredAt string
  
  Required
  
  The UTC timestamp when the delivery was triggered.
  
  format = "date-time"
- statusMessage string
  
  The status message of the delivery.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/webhooks/{id}/deliveries/{deliveryId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhookDelivery(
  'string',
  'string',
)

qlik webhook delivery get 'string' \
  --webhookId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}/deliveries/{deliveryId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "status": "success",
  "request": {
    "url": "string",
    "body": {},
    "headers": {
      "headerName": "headerValue",
      "encryptedHeadersName": "**OMITTED**"
    }
  },
  "response": {
    "body": "string",
    "headers": {
      "headerName": "headerValue",
      "encryptedHeadersName": "**OMITTED**"
    },
    "statusCode": 42
  },
  "eventType": "string",
  "webhookId": "string",
  "triggeredAt": "2018-10-30T07:06:22Z",
  "statusMessage": "string"
}

Resends the delivery with the same payload.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deliveryId string

Required

The delivery's unique identifier.
id string

Required

The webhook's unique identifier.

Responses

201

OK Response

application/json object
Show application/json properties
- id string
  
  Required
  
  The delivery's unique identifier.
- status string
  
  Required
  
  The status of delivery.
  
  Can be one of: "success""fail"
- request object
  
  Request details for the delivery.
  
  Show request properties
  
  url string
  
  URL used for this delivery.
  
  body object
  
  The sent body/payload of the delivery.
  
  headers object
  
  Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
- response object
  
  Response details for the delivery.
  
  Show response properties
  
  body string
  
  The received body of the delivery.
  
  headers object
  
  Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.
  
  Show additional optional properties
  
  string string
  
  statusCode number
  
  The HTTP status code of the response.
- eventType string
  
  Required
  
  The name of the triggering event-type.
- webhookId string
  
  Required
  
  The unique webhook identifier that the delivery is for.
- triggeredAt string
  
  Required
  
  The UTC timestamp when the delivery was triggered.
  
  format = "date-time"
- statusMessage string
  
  The status message of the delivery.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

404

Not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resend

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.resendWebhookDelivery(
  'string',
  'string',
)

qlik webhook delivery resend \
  --webhookId 'string' \
  --deliveryId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resend" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "status": "success",
  "request": {
    "url": "string",
    "body": {},
    "headers": {
      "headerName": "headerValue",
      "encryptedHeadersName": "**OMITTED**"
    }
  },
  "response": {
    "body": "string",
    "headers": {
      "headerName": "headerValue",
      "encryptedHeadersName": "**OMITTED**"
    },
    "statusCode": 42
  },
  "eventType": "string",
  "webhookId": "string",
  "triggeredAt": "2018-10-30T07:06:22Z",
  "statusMessage": "string"
}

Lists event-types that are possible to subscribe to.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  name string
  
  Name of the event type.
  
  title string
  
  Title of the event type.
  
  levels array of strings
  
  Specifies which levels that are supported for this event type.
  
  category string
  
  Category of the event type.
  
  description string
  
  Description of the event type.
  
  allowedFilters array of objects
  
  The set of fields that can be used to filter this specific event type for webhook delivery. Different event types may support different filter paths.
  
  Show allowedFilters properties
  
  path string
  
  Required
  
  The field name or path that can be used as a filter.
  
  allowedValues array of strings
  
  Optional allowed values for this filter path. If omitted, the path is treated as free-form and clients are responsible for valid usage.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error.
  
  title string
  
  Required
  
  A summary of what went wrong.
  
  detail string
  
  May be used to provide additional details.
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/webhooks/event-types

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhookEventTypes()

qlik webhook event-types

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/webhooks/event-types" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "name": "string",
      "title": "string",
      "levels": [
        "string"
      ],
      "category": "string",
      "description": "string",
      "allowedFilters": [
        {
          "path": "data.status",
          "allowedValues": [
            "success",
            "fail"
          ]
        }
      ]
    }
  ]
}

Webhooks

Endpoints

List webhooks

Facts

Query Parameters

Responses

200

400

401

403

500

503

Example Response

Create a new webhook

Facts

Request Body

Responses

201

400

401

403

500

503

Example Response

Get a webhook

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Example Response

Update one or more webhook properties

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

503

Update all webhook properties

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

503

Example Response

Delete a webhook

Facts

Path Parameters

Responses

204

400

401

403

404

500

503

Return deliveries for a webhook

Facts

Query Parameters

Path Parameters

Responses

200

400

401