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)
Categories	manage

Query Parameters

createdByUserIdstring

Filter resources by user that created it.
enabledboolean

Filter resources by enabled true/false.
eventTypesstring

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

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

Maximum number of webhooks to retrieve.

minimum = 1, maximum = 100, default = 20, default = 20
namestring

Filter resources by name (wildcard and case insensitive).
nextstring

Cursor to the next page.
originsstring

Filter resources by origins, supports multiorigin.

Can be one of: "api""automations""management-console"
ownerIdstring

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

Cursor to the previous page.
sortstring

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"
updatedByUserIdstring

Filter resources by user that last updated the webhook.
urlstring

Filter resources by URL (wildcard and case insensitive).

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  The webhook's unique identifier.
  
  urlstring
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
  
  namestring
  Required
  
  The name for the webhook.
  
  maxLength = 512
  
  levelstring
  
  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"
  
  filterstring
  
  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.
  
  secretstringDeprecatedSunset 2025-11
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
  
  enabledboolean
  
  Whether the webhook is active and sending requests.
  
  default = false
  
  headersobject
  
  Additional headers in the post request.
  
  additional properties
  
  ownerIdstring
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
  
  createdAtstring
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
  
  eventTypesarray of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
  
  descriptionstring
  
  The reason for creating the webhook.
  
  maxLength = 1024
  
  disabledReasonstring
  
  The reason for the webhook to be disabled.
  
  secretKeyAddedboolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
  
  createdByUserIdstring
  
  The id of the user that created the webhook.
  
  updatedByUserIdstring
  
  The id of the user that last updated the webhook.
  
  encryptedHeadersarray of strings
  
  Additional encrypted headers in the post request.
  
  disabledReasonCodestring
  
  The unique code for the reason.
  
  enableCloudEventDeliveryboolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
  
  checkCertificateRevocationboolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
  
  originstring
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  
  default = "api"
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL to a resource request.
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL to a resource request.
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL to a resource request.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

GET /api/v1/webhooks

import { createQlikApi } from '@qlik/api'

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

await qlik.webhooks.getWebhooks({})

qlik webhook ls

curl "https://your-tenant.us.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\"",
      "secret": "string",
      "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)
Categories	manage

Request Body

Required

application/jsonobject
Show application/json properties
- urlstring
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- namestring
  Required
  
  The name for the webhook.
  
  maxLength = 512
- levelstring
  
  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"
- filterstring
  
  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.
- secretstring
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabledboolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headersobject
  
  Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive.
  
  additional properties
- ownerIdstring
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- eventTypesarray of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- descriptionstring
  
  The reason for creating the webhook.
  
  maxLength = 1024
- encryptedHeadersobject
  
  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.
  
  additional properties
- enableCloudEventDeliveryboolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocationboolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- originstring
  
  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/jsonobject
Show application/json properties
- idstring
  
  The webhook's unique identifier.
- urlstring
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- namestring
  Required
  
  The name for the webhook.
  
  maxLength = 512
- levelstring
  
  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"
- filterstring
  
  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.
- secretstringDeprecatedSunset 2025-11
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabledboolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headersobject
  
  Additional headers in the post request.
  
  additional properties
- ownerIdstring
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- createdAtstring
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
- updatedAtstring
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
- eventTypesarray of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- descriptionstring
  
  The reason for creating the webhook.
  
  maxLength = 1024
- disabledReasonstring
  
  The reason for the webhook to be disabled.
- secretKeyAddedboolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
- createdByUserIdstring
  
  The id of the user that created the webhook.
- updatedByUserIdstring
  
  The id of the user that last updated the webhook.
- encryptedHeadersarray of strings
  
  Additional encrypted headers in the post request.
- disabledReasonCodestring
  
  The unique code for the reason.
- enableCloudEventDeliveryboolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocationboolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- originstring
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  
  default = "api"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

POST /api/v1/webhooks

import { createQlikApi } from '@qlik/api'

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

await qlik.webhooks.createWebhook({
  description: 'string',
  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 \
--description="string" \
--eventTypes='"string"' \
--filter="id eq "id123" or spaceId eq "spaceId123" or spaceId eq "spaceId456" or topLevelResourceId eq "id789"" \
--level="tenant" \
--name="string" \
--origin="api" \
--ownerId="string" \
--secret="string" \
--url="string"

curl "https://your-tenant.us.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\"",
  "secret": "string",
  "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)
Categories	manage

Path Parameters

idstring
Required

The webhook's unique identifier.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The webhook's unique identifier.
- urlstring
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- namestring
  Required
  
  The name for the webhook.
  
  maxLength = 512
- levelstring
  
  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"
- filterstring
  
  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.
- secretstringDeprecatedSunset 2025-11
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabledboolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headersobject
  
  Additional headers in the post request.
  
  additional properties
- ownerIdstring
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- createdAtstring
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
- updatedAtstring
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
- eventTypesarray of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- descriptionstring
  
  The reason for creating the webhook.
  
  maxLength = 1024
- disabledReasonstring
  
  The reason for the webhook to be disabled.
- secretKeyAddedboolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
- createdByUserIdstring
  
  The id of the user that created the webhook.
- updatedByUserIdstring
  
  The id of the user that last updated the webhook.
- encryptedHeadersarray of strings
  
  Additional encrypted headers in the post request.
- disabledReasonCodestring
  
  The unique code for the reason.
- enableCloudEventDeliveryboolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocationboolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- originstring
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  
  default = "api"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhook('string')

qlik webhook get <webhookId>

curl "https://your-tenant.us.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\"",
  "secret": "string",
  "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)
Categories	manage

Path Parameters

idstring
Required

The webhook's unique identifier.

Request Body

Required

application/jsonarray of objects

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "add""remove""replace"
- pathstring
  Required
  
  The path for the given resource field to patch.
  
  Can be one of: "/name""/description""/url""/eventTypes""/headers""/enabled""/secret""/encryptedHeaders""/enableCloudEventDelivery"
- valueboolean|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/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

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

qlik webhook patch <webhookId> \
--body='[{"op":"add","path":"/description","value":true}]'

curl "https://your-tenant.us.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)
Categories	manage

Path Parameters

idstring
Required

The webhook's unique identifier.

Request Body

Required

application/jsonobject
Show application/json properties
- urlstring
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- namestring
  Required
  
  The name for the webhook.
  
  maxLength = 512
- levelstring
  
  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"
- filterstring
  
  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.
- secretstring
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabledboolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headersobject
  
  Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive.
  
  additional properties
- ownerIdstring
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- eventTypesarray of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- descriptionstring
  
  The reason for creating the webhook.
  
  maxLength = 1024
- encryptedHeadersobject
  
  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.
  
  additional properties
- enableCloudEventDeliveryboolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocationboolean
  
  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/jsonobject
Show application/json properties
- idstring
  
  The webhook's unique identifier.
- urlstring
  Required
  
  Target URL for webhook HTTPS requests.
  
  maxLength = 2048
- namestring
  Required
  
  The name for the webhook.
  
  maxLength = 512
- levelstring
  
  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"
- filterstring
  
  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.
- secretstringDeprecatedSunset 2025-11
  
  String used as secret for calculating HMAC hash sent as header.
  
  minLength = 32, maxLength = 64
- enabledboolean
  
  Whether the webhook is active and sending requests.
  
  default = false
- headersobject
  
  Additional headers in the post request.
  
  additional properties
- ownerIdstring
  
  The id of the user that owns the webhook, only applicable for user level webhooks.
- createdAtstring
  
  The UTC timestamp when the webhook was created.
  
  format = "date-time"
- updatedAtstring
  
  The UTC timestamp when the webhook was last updated.
  
  format = "date-time"
- eventTypesarray of strings
  
  Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.
- descriptionstring
  
  The reason for creating the webhook.
  
  maxLength = 1024
- disabledReasonstring
  
  The reason for the webhook to be disabled.
- secretKeyAddedboolean
  
  Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not.
- createdByUserIdstring
  
  The id of the user that created the webhook.
- updatedByUserIdstring
  
  The id of the user that last updated the webhook.
- encryptedHeadersarray of strings
  
  Additional encrypted headers in the post request.
- disabledReasonCodestring
  
  The unique code for the reason.
- enableCloudEventDeliveryboolean
  
  If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.
  
  default = true
- checkCertificateRevocationboolean
  
  If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.
  
  default = false
- originstring
  
  Indicates from where the webhook was created and its purpose.
  
  Can be one of: "api""automations""management-console"
  
  default = "api"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.updateWebhook('string', {
  description: 'string',
  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 <webhookId> \
--description="string" \
--eventTypes='"string"' \
--filter="id eq "id123" or spaceId eq "spaceId123" or spaceId eq "spaceId456" or topLevelResourceId eq "id789"" \
--level="tenant" \
--name="string" \
--ownerId="string" \
--secret="string" \
--url="string"

curl "https://your-tenant.us.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\"",
  "secret": "string",
  "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)
Categories	manage

Path Parameters

idstring
Required

The webhook's unique identifier.

Responses

204

No Content response.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.deleteWebhook('string')

qlik webhook rm <webhookId>

curl "https://your-tenant.us.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)
Categories	manage

Query Parameters

eventTypestring

Filter resources by event-type.
limitnumber

Maximum number of deliveries to retrieve.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

Cursor to the next page.
prevstring

Cursor to the previous page.
sortstring

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

Can be one of: "status""+status""-status""triggeredAt""+triggeredAt""-triggeredAt"

default = "-triggeredAt"
statusstring

Filter resources by status (success or fail).

Can be one of: "success""fail"

Path Parameters

idstring
Required

The webhook's unique identifier.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  The delivery's unique identifier.
  
  statusstring
  Required
  
  The status of delivery.
  
  Can be one of: "success""fail"
  
  requestobject
  
  Request details for the delivery.
  
  Show request properties
  
  urlstring
  
  URL used for this delivery.
  
  bodyobject
  
  The sent body/payload of the delivery.
  
  headersobject
  
  Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED".
  
  additional properties
  
  responseobject
  
  Response details for the delivery.
  
  Show response properties
  
  bodystring
  
  The received body of the delivery.
  
  headersobject
  
  Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED".
  
  additional properties
  
  statusCodenumber
  
  The HTTP status code of the response.
  
  eventTypestring
  Required
  
  The name of the triggering event-type.
  
  webhookIdstring
  Required
  
  The unique webhook identifier that the delivery is for.
  
  triggeredAtstring
  Required
  
  The UTC timestamp when the delivery was triggered.
  
  format = "date-time"
  
  statusMessagestring
  
  The status message of the delivery.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL to a resource request.
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL to a resource request.
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL to a resource request.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

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

qlik webhook delivery ls

curl "https://your-tenant.us.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)
Categories	manage

Path Parameters

deliveryIdstring
Required

The delivery's unique identifier.
idstring
Required

The webhook's unique identifier.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The delivery's unique identifier.
- statusstring
  Required
  
  The status of delivery.
  
  Can be one of: "success""fail"
- requestobject
  
  Request details for the delivery.
  
  Show request properties
  
  urlstring
  
  URL used for this delivery.
  
  bodyobject
  
  The sent body/payload of the delivery.
  
  headersobject
  
  Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED".
  
  additional properties
- responseobject
  
  Response details for the delivery.
  
  Show response properties
  
  bodystring
  
  The received body of the delivery.
  
  headersobject
  
  Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED".
  
  additional properties
  
  statusCodenumber
  
  The HTTP status code of the response.
- eventTypestring
  Required
  
  The name of the triggering event-type.
- webhookIdstring
  Required
  
  The unique webhook identifier that the delivery is for.
- triggeredAtstring
  Required
  
  The UTC timestamp when the delivery was triggered.
  
  format = "date-time"
- statusMessagestring
  
  The status message of the delivery.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

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

qlik webhook delivery get <deliveryId>

curl "https://your-tenant.us.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)
Categories	manage

Path Parameters

deliveryIdstring
Required

The delivery's unique identifier.
idstring
Required

The webhook's unique identifier.

Responses

201

OK Response

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The delivery's unique identifier.
- statusstring
  Required
  
  The status of delivery.
  
  Can be one of: "success""fail"
- requestobject
  
  Request details for the delivery.
  
  Show request properties
  
  urlstring
  
  URL used for this delivery.
  
  bodyobject
  
  The sent body/payload of the delivery.
  
  headersobject
  
  Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED".
  
  additional properties
- responseobject
  
  Response details for the delivery.
  
  Show response properties
  
  bodystring
  
  The received body of the delivery.
  
  headersobject
  
  Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED".
  
  additional properties
  
  statusCodenumber
  
  The HTTP status code of the response.
- eventTypestring
  Required
  
  The name of the triggering event-type.
- webhookIdstring
  Required
  
  The unique webhook identifier that the delivery is for.
- triggeredAtstring
  Required
  
  The UTC timestamp when the delivery was triggered.
  
  format = "date-time"
- statusMessagestring
  
  The status message of the delivery.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

404

Not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

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

qlik webhook delivery resend \
--deliveryId="string"

curl "https://your-tenant.us.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)
Categories	manage

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  namestring
  
  Name of the event type.
  
  titlestring
  
  Title of the event type.
  
  levelsarray of strings
  
  Specifies which levels that are supported for this event type.
  
  descriptionstring
  
  Description of the event type.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error.
  
  titlestring
  Required
  
  A summary of what went wrong.
  
  detailstring
  
  May be used to provide additional details.
- traceIdstring
  
  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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.webhooks.getWebhookEventTypes()

qlik webhook event-types

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

Example Response

{
  "data": [
    {
      "name": "string",
      "title": "string",
      "levels": [
        "string"
      ],
      "description": "string"
    }
  ]
}

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