webhooks
Webhooks are a way for Qlik Cloud to provide other applications with real-time information.
Endpoints
Skip to sectionGET | /webhooks |
POST | /webhooks |
GET | /webhooks/event-types |
GET | /webhooks/{id} |
PUT | /webhooks/{id} |
PATCH | /webhooks/{id} |
DELETE | /webhooks/{id} |
GET | /webhooks/{id}/deliveries |
GET | /webhooks/{id}/deliveries/{deliveryId} |
POST | /webhooks/{id}/deliveries/{deliveryId}/actions/resend |
Retrieves all webhooks entries for a tenant
Query Parameters GET /webhooks
sort default='-createdAt' string | Field to sort by, prefix with -/+ to indicate order Enum: name +name -name url +url -url createdAt +createdAt -createdAt updatedAt +updatedAt -updatedAt |
limit default=20, minimum=1, maximum=100 number | Maximum number of webhooks to retrieve |
next string | Cursor to the next page |
prev string | Cursor to previous next page |
name string | Filter resources by name (wildcard and case insensitive) |
url string | Filter resources by url (wildcard and case insensitive) |
eventType string | Filter resources by event-type |
enabled boolean | Filter resources by enabled true/false |
createdByUserId string | Filter resources by user that created it |
level string | Filter resources by level that user has access to (either user or level) |
updatedByUserId string | Filter resources by user that last updated the webhook |
ownerId string | Filter resources by user that owns it, only applicable for user level webhooks |
Responses GET /webhooks
200 application/json | OK Response |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
GET/webhooks
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks" \
-H "Authorization: Bearer <API-key>"
Response GET /webhooks
{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"eventTypes": [],
"headers": {
"headerName": "headerValue"
},
"enabled": true,
"secret": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"ownerId": "string",
"createdAt": "2022-05-18T10:58:16.599Z",
"updatedAt": "2022-05-18T10:58:16.599Z",
"level": "tenant",
"filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"",
"disabledReason": "string",
"disabledReasonCode": "string"
}
],
"links": {
"next": {
"href": "string"
},
"self": {
"href": "string"
},
"prev": {
"href": "string"
}
}
}
Creates a new webhook
Request Body POST /webhooks
application/json | No description |
Responses POST /webhooks
201 application/json | OK Response |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
POST/webhooks
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"id":"string","name":"string","description":"string","url":"string","eventTypes":[],"headers":{"headerName":"headerValue"},"enabled":true,"secret":"string","createdByUserId":"string","updatedByUserId":"string","ownerId":"string","createdAt":"2022-05-18T10:58:16.600Z","updatedAt":"2022-05-18T10:58:16.600Z","level":"tenant","filter":"id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"","disabledReason":"string","disabledReasonCode":"string"}'
Request POST /webhooks
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"eventTypes": [],
"headers": {
"headerName": "headerValue"
},
"enabled": true,
"secret": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"ownerId": "string",
"createdAt": "2022-05-18T10:58:16.600Z",
"updatedAt": "2022-05-18T10:58:16.600Z",
"level": "tenant",
"filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"",
"disabledReason": "string",
"disabledReasonCode": "string"
}
Response POST /webhooks
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"eventTypes": [],
"headers": {
"headerName": "headerValue"
},
"enabled": true,
"secret": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"ownerId": "string",
"createdAt": "2022-05-18T10:58:16.600Z",
"updatedAt": "2022-05-18T10:58:16.600Z",
"level": "tenant",
"filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"",
"disabledReason": "string",
"disabledReasonCode": "string"
}
List of event-types that are possible to subscribe to.
Responses GET /webhooks/event-types
200 application/json | OK Response |
401 application/json | Unauthorized |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
GET/webhooks/event-types
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/event-types" \
-H "Authorization: Bearer <API-key>"
Response GET /webhooks/event-types
{
"data": [
{
"title": "string",
"name": "string",
"description": "string",
"levels": []
}
]
}
Returns details for a specific webhook
Path Parameters GET /webhooks/{id}
id string | The webhook's unique identifier. |
Responses GET /webhooks/{id}
200 application/json | OK Response |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
GET/webhooks/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}" \
-H "Authorization: Bearer <API-key>"
Response GET /webhooks/{id}
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"eventTypes": [],
"headers": {
"headerName": "headerValue"
},
"enabled": true,
"secret": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"ownerId": "string",
"createdAt": "2022-05-18T10:58:16.600Z",
"updatedAt": "2022-05-18T10:58:16.600Z",
"level": "tenant",
"filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"",
"disabledReason": "string",
"disabledReasonCode": "string"
}
Updates a webhook
Path Parameters PUT /webhooks/{id}
id string | The webhook's unique identifier. |
Request Body PUT /webhooks/{id}
application/json | No description |
Responses PUT /webhooks/{id}
200 application/json | OK Response |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
PUT/webhooks/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}" \
-X PUT \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"id":"string","name":"string","description":"string","url":"string","eventTypes":[],"headers":{"headerName":"headerValue"},"enabled":true,"secret":"string","createdByUserId":"string","updatedByUserId":"string","ownerId":"string","createdAt":"2022-05-18T10:58:16.600Z","updatedAt":"2022-05-18T10:58:16.600Z","level":"tenant","filter":"id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"","disabledReason":"string","disabledReasonCode":"string"}'
Request PUT /webhooks/{id}
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"eventTypes": [],
"headers": {
"headerName": "headerValue"
},
"enabled": true,
"secret": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"ownerId": "string",
"createdAt": "2022-05-18T10:58:16.600Z",
"updatedAt": "2022-05-18T10:58:16.600Z",
"level": "tenant",
"filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"",
"disabledReason": "string",
"disabledReasonCode": "string"
}
Response PUT /webhooks/{id}
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"eventTypes": [],
"headers": {
"headerName": "headerValue"
},
"enabled": true,
"secret": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"ownerId": "string",
"createdAt": "2022-05-18T10:58:16.600Z",
"updatedAt": "2022-05-18T10:58:16.600Z",
"level": "tenant",
"filter": "id eq \"id123\" or spaceId eq \"spaceId123\" or spaceId eq \"spaceId456\"",
"disabledReason": "string",
"disabledReasonCode": "string"
}
Patches a webhook
Path Parameters PATCH /webhooks/{id}
id string | The webhook's unique identifier. |
Request Body PATCH /webhooks/{id}
application/json | No description |
Responses PATCH /webhooks/{id}
204 object | No Content response. |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
PATCH/webhooks/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}" \
-X PATCH \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"op":"add","path":"/description","value":"string"}'
Request PATCH /webhooks/{id}
{
"op": "add",
"path": "/description",
"value": "string"
}
Deletes a specific webhook
Path Parameters DELETE /webhooks/{id}
id string | The webhook's unique identifier. |
Responses DELETE /webhooks/{id}
204 object | No Content response. |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
DELETE/webhooks/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Returns deliveries for a specific webhook
Path Parameters GET /webhooks/{id}/deliveries
id string | The webhook's unique identifier. |
Query Parameters GET /webhooks/{id}/deliveries
sort default='-triggeredAt' string | Field to sort by, prefix with -/+ to indicate order Enum: status +status -status triggeredAt +triggeredAt -triggeredAt |
status string | Filter resources by status (success or fail) Enum: success fail |
eventType string | Filter resources by event-type |
limit default=20, minimum=1, maximum=100 number | Maximum number of deliveries to retrieve |
next string | Cursor to the next page |
prev string | Cursor to previous next page |
Responses GET /webhooks/{id}/deliveries
200 application/json | OK Response |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
GET/webhooks/{id}/deliveries
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}/deliveries" \
-H "Authorization: Bearer <API-key>"
Response GET /webhooks/{id}/deliveries
{
"data": [
{
"id": "string",
"webhookId": "string",
"triggeredAt": "2022-05-18T10:58:16.601Z",
"status": "success",
"statusMessage": "string",
"eventType": "string",
"request": {
"url": "string",
"headers": {
"headerName": "headerValue"
},
"body": {}
},
"response": {
"statusCode": 0,
"headers": {
"headerName": "headerValue"
},
"body": "string"
}
}
],
"links": {
"next": {
"href": "string"
},
"self": {
"href": "string"
},
"prev": {
"href": "string"
}
}
}
Returns details for a specific delivery
Path Parameters GET /webhooks/{id}/deliveries/{deliveryId}
id string | The webhook's unique identifier. |
deliveryId string | The delivery's unique identifier. |
Responses GET /webhooks/{id}/deliveries/{deliveryId}
200 application/json | OK Response |
400 application/json | Bad Request |
401 application/json | Unauthorized |
403 application/json | Forbidden |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
GET/webhooks/{id}/deliveries/{deliveryId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}/deliveries/{deliveryId}" \
-H "Authorization: Bearer <API-key>"
Response GET /webhooks/{id}/deliveries/{deliveryId}
{
"id": "string",
"webhookId": "string",
"triggeredAt": "2022-05-18T10:58:16.601Z",
"status": "success",
"statusMessage": "string",
"eventType": "string",
"request": {
"url": "string",
"headers": {
"headerName": "headerValue"
},
"body": {}
},
"response": {
"statusCode": 0,
"headers": {
"headerName": "headerValue"
},
"body": "string"
}
}
Resend the delivery with the same payload
Path Parameters POST /webhooks/{id}/deliveries/{deliveryId}/actions/resend
id string | The webhook's unique identifier. |
deliveryId string | The delivery's unique identifier. |
Responses POST /webhooks/{id}/deliveries/{deliveryId}/actions/resend
201 application/json | OK Response |
401 application/json | Unauthorized |
404 application/json | Not found |
500 application/json | Internal Server Error |
503 application/json | Service Unavailable |
POST/webhooks/{id}/deliveries/{deliveryId}/actions/resend
curl "https://your-tenant.us.qlikcloud.com/api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resend" \
-X POST \
-H "Authorization: Bearer <API-key>"
Response POST /webhooks/{id}/deliveries/{deliveryId}/actions/resend
{
"id": "string",
"webhookId": "string",
"triggeredAt": "2022-05-18T10:58:16.601Z",
"status": "success",
"statusMessage": "string",
"eventType": "string",
"request": {
"url": "string",
"headers": {
"headerName": "headerValue"
},
"body": {}
},
"response": {
"statusCode": 0,
"headers": {
"headerName": "headerValue"
},
"body": "string"
}
}
BadRequest
Bad Request
Forbidden
Forbidden
NotFound
Not found
InternalServerError
Internal Server Error
ErrorResponse
objectProperties
errors | No description |
traceId string | A way to trace the source of the error. |
Error
objectProperties
code string | The unique code for the error |
title string | A summary of what went wrong |
detail optional string | May be used to provide additional details |
WebhookList
objectProperties
data | No description |
links | No description |
Webhook
objectProperties
id optional string | The webhook's unique identifier |
name string | The name for the webhook |
description optional string | The reason for creating the webhook |
url string | Target URL for webhook HTTPS requests |
eventTypes optional Array<string> | Types of events for which the webhook should trigger. |
headers optional object | Additional headers in the post request |
enabled optional, default=false boolean | Whether the webhook is active and sending requests |
secret optional string | String used as secret for calculating HMAC hash sent as header |
createdByUserId optional string | The id of the user that created the webhook |
updatedByUserId optional string | The id of the user that last updated the webhook |
ownerId optional string | The id of the user that owns the webhook, only applicable for user level webhooks |
createdAt optional string<date-time> | The UTC timestamp when the webhook was created |
updatedAt optional string<date-time> | The UTC timestamp when the webhook was last updated |
level optional, default='tenant' 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. Enum: tenant user |
filter optional string | Filter that should match for a webhook to be triggered. Supported attribute names are 'id' and 'spaceId'. 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 following link to external documentation. |
disabledReason optional string | The reason for the webhook to be disabled |
disabledReasonCode optional string | The unique code for the reason |
WebhookPatch
objectA JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902
Properties
op string | The operation to be performed Enum: add remove replace |
path string | The path for the given resource field to patch Enum: /name /description /url /eventTypes /headers /enabled /secret |
value optional string | The value to be used for this operation. |
EventTypes
objectProperties
data | No description |
EventType
objectProperties
title string | Title of the event type |
name string | Name of the event type |
description string | Description of the event type |
levels Array<string> | Specifies which levels that are supported for this event type |
DeliveryList
objectProperties
data | No description |
links | No description |
Delivery
objectProperties
id string | The delivery's unique identifier |
webhookId string | The unique webhook identifier that the delivery is for |
triggeredAt string<date-time> | The UTC timestamp when the delivery was triggered |
status string | The status of delivery Enum: success fail |
statusMessage optional string | The status message of the delivery |
eventType string | The name of the triggering event-type |
request optional | No description |
response optional | No description |
Link
Properties
href string | URL to a resource request |