Skip to main content
Close announcements banner
Working with webhooks

ON THIS PAGE

Working with webhooks

An automation can be triggered by using the webhook URL of the automation or by native webhooks. To trigger an automation using its webhook URL, set the start block run mode to Triggered. To trigger an automation using a webhook connector, set the start block run mode to Webhook.

Triggered webhooks

Triggered webhooks make API calls to the Qlik Cloud service from another platform through its webhook URL.

Information note

Refer to platform limitations to see the API call limits.

Triggered Webhooks

Getting the automation URL

Automations are exposed through a REST API endpoint, which means they can be called with a webhook URL to trigger the automation. To get the webhook URL, set the start block run mode to Triggered. The block configuration pane displays a GET and POST curl command with the webhook URL.

Warning note

The automation webhook URL contains a token that should be kept secret. Do not share it publicly and do not store it on public version control repositories.

Triggered start block inputs

webhook url from a start block

Information note

You can add the X-Execution-Token to the query string rather than including it in the header, and you can replace the automation GUID with the automation name.

Viewing the webhook payload

When you call the automation with a webhook URL, the start block receives input from the webhook. To view the payload, use an output block and set the start block as the input.

Mapping start block to output block

start block as the input for an output block

Information note

You can change the input field to retrieve a specific part of the JSON payload, for example {$.Start.name}. Alternatively, you can use input blocks to specify part of the JSON payload.

Defining input parameters

You can add an input block below the start block to receive the payload from the webhook URL. Below the input block, you can add other blocks that retrieves part of the data.

For example, you could use the input block to receive the full payload, which is a JSON array, and select only the required field from the input block output.

Input parameters

Automation showing input from payload and posting a message to Slack

Native webhooks

Native webhooks use an API call to create an event in the platform you select under Connector. Native webhooks include preconfigured connectors, like the Qlik Cloud connector.

Working with native webhooks

Set the start block run mode to Webhook to use native webhooks.

Webhook run mode

Webhook start block option

You must authenticate the data connector of the selected webhook. Once it is authenticated, select which event triggers the automation. In the image below, the automation runs whenever a Qlik Cloud app is created.

Information note

Tenant admins have access to all events, while other user roles only have access to a subset of the events.

Native Webhooks
Start block as a webhook

Webhook start block with event app created

Filtering

By using filters, you can limit the webhook to trigger only on specific apps or apps in specific spaces. The filter can include multiple apps and spaces. Use the do lookup function to easily add the ID of an app or a space.

The events App Created and App Published can only be filtered by space ID because the app ID is not known before these events have occurred.

Webhook for the App Reload Finished event filtered by space ID

Webhook with a filter specifying a space ID

Modifying the test payload

You can modify the test payload to include objects that you want to retrieve during a test run. The actual payload can be different from the test payload.

For example, here is a simple automation that outputs the name of the app when that app is reloaded. The start block is set to Webhook and the event that triggers the automation is an app reload.

App reload automation with webhook start block

A simple automation with two blocks showing the start block configured as a webhook

The test payload field is edited to only include the data object.

{
  "data": {
    "id": "94a789ad-d967-4049-8aaf-9abac267c222",
    "name": "MyApp"
   }
}

When you run this automation and look at the start block output, it shows only the test payload. When the automation is triggered through the Qlik Cloud webhook, the start block output shows the actual payload.

{
  ...
  },
  "data": {
    "duration": 1345,
    "endTime": "2021-09-14T18:30:06.288Z",
    "errors": [],
    "id": "ff241d45-6605-432d-9ec5-8cf4e9a64807",
    "name": "JIRA app",
    "peakMemoryBytes": 4985984,
    "reloadId": "6140ea2554b901cc5a122461",
    "size": {
      "memory": 16845
    },
    "status": "ok",
    "warnings": []
  }
}

Managing webhooks as an administrator

Automations that have a webhook in the start block are listed in the Management Console under Webhooks. Only tenant administrators can access the Webhooks section of the Management Console.

Webhooks table in the Management Console

The management console webhooks table showing a webhook and the expanded view

To learn how to manage webhooks from the Management Console, see Webhooks.