All Commands Reference

The following pages will show you (almost) all of the commands that Captivate makes available to API consumers.

You can call these commands with the ServiceHandler library by using the scheduleCommand method on the scheduler object as described in the JavaScript API Reference, and this reference assumes you are familiar with information contained there.

You can also call these commands through the use of one of our Advanced API connection methods.

These reference will describe the commands according to the HTTP connection method but they can easily be translated back to the scheduleCommand method.

Translating from this documentation back to scheduleCommand

For /api/command/ endpoints:

await ServiceHandler.scheduler.scheduleCommand([command], [params], [variables]);

• command is the path element after /api/command/

• params is an object described by the properties field

• variables is an object with the variables to set.

• all arguments are required

For /api/action/ endpoints:

await ServiceHandler.scheduler.scheduleAction([action], [input], [title], [variables]);

• action is the path element after /api/action/

• input is the input name to target

• title is the id or the name of the title to target

• variables is an object with the variables to set

• all arguments are required, so to target just an input or a title, pass an empty string for the other one