Reference docs

Detailed, more technical descriptions of Butler’s REST API and other parts of Butler.

Config file syntax

Description of Butler’s config file.

REST API documentation

OpenAPI/Swagger style documentation for the Butler API.


Details about the Butler scheduler.

Key-value store

Details about the Butler key-value store.

Alert template fields

List of template fields available in Butler alert messages.

Helper subs that make it easy to use Butler APIs

Butler exposes a REST API that can be called from many different systems and tools, just not Qlik Sense itself.

When it comes to Sense, it’s very doable but not entirely easy to call REST APIs from an app’s load script. Butler comes with a set of subs/functions that wrap the API calls and make it a lot easier and cleaner to call Butler APIs from load scripts.

This page describes those subs.

Last modified 2021-04-22: First commit (c105eb7)