Controller API Reference

Overview

The Controller API is the primary way of interacting with Captivate from a data controller. If you are building your own data controller, make sure you read the Controller Setup Page to learn how to set up your input definition with an XML file and where to put your own HTML files and other assets.

JavaScript-based data controllers are usually hosted by an HTML file loaded into a browser (either Captivate’s built in browser, or a local browser on your computer or mobile device).

Your HTML file should provide some form of UI as well as the JavaScript code to make use of our exposed API.

If you want to access Captivate’s API from outside of the context of an HTML file in a browser, first, get familiar with how the Controller API works, and then head over to our External API Reference.