Extending ftrack

There are various methods to enhance the ftrack web application and personalize the user experience. This is a popular approach to automate repetitive tasks or present data from new perspectives.

In this section, we'll delve deeper into how to effectively utilize ftrack's API for these purposes.

📄️ Actions

An action is a script that is executed from the ftrack interface. It can be used to extend functionality in ftrack such as generating reports, launching applications or opening a custom UI. A custom action can be setup to run from inside connect by adding a hook or as a standalone script to perform company-wide operations.

📄️ Widgets

With ftrack comes a set of standard widgets that can be used on dashboards. In addition to these widgets it is possible for you to build and add your own widgets. A widget is a html page shown in an iframe. This works by creating a web page that uses the ftrack API and show it using the Web view dashboard widget, Custom widget on Overview or when launching an action.

📄️ Creating a widget with React

An easy way to get started building a React application is by using create-react-app.

📄️ Websocket events

By subscribing to the ftrack.update topic, you connect your application or script to the ftrack event hub. When an entity is changed, an event is emitted on this topic and your callback function is triggered.

📄️ Webhooks

Webhooks are available from ftrack version 24.6.