JavaScript

The ftrack JavaScript API Client is a JavaScript library to help developing integrations that communicate with the ftrack API and Event server.

This documentation focuses on the client. More information about the API and its concepts can be found at our general API documentation. You may also find it useful to look at the documentation for the Python client.

Overview

📄️ Installing

Installation is simple with your favorite package manager:

📄️ Tutorial

The API uses sessions to manage communication with an ftrack server. Create a session that connects to your ftrack server (changing the passed values as appropriate):

📄️ Handling events

The EventHub is a class that provides functionality to interact with an ftrack event server. It allows you to connect to the event server, subscribe to specific events, publish events, and handle event responses.