Developer Hub

Welcome to the ftrack Developer Hub. You’ll find comprehensive guides and documentation to help you start working with ftrack as quickly as possible, as well as support if you get stuck. Let’s jump right in!
https://www.ftrack.com/wp-content/themes/salient/css/fonts/svg/basic_heart.svg

Overview

https://www.ftrack.com/wp-content/themes/salient/css/fonts/svg/basic_spread_bookmark.svg

Examples

https://www.ftrack.com/wp-content/themes/salient/css/fonts/svg/basic_folder_multiple.svg

Client Libraries

Our API provides great flexibility and power whilst remaining approachable and intuitive. Whether you’re writing your very first script or you’re an experienced software architect, you’ll find our API works the way you need it to. We’ve gone the extra mile by building in some of the features that we see developers having to continually implement in-house across different companies – features such as caching and support for custom pipeline extensions and more – to make your life that little bit easier.

Get started

Key concepts

Some of the key concepts in our API

Events

Events are generated in ftrack when things happen such as a task being updated or a new version being published. API clients can listen to these events and perform an action as a result. For example, the action could be updating another related entity based on a status change or generating folders when a new shot is created.

Learn more

Actions

An action is a custom 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.

Learn more

Widgets

A collection of standard widgets are available in ftrack that can be used on dashboards or Actions. If you’re a developer and want to add your own widgets you can, by simply creating a web page that uses the ftrack API. This page can then be displayed using the web view dashboard widget or when launching an action in ftrack.

Learn more

Locations

Our Locations framework make it easier than ever to share data across teams and time zones. Locations is an effective way to easily track and manage data (files, image sequences etc.) using ftrack across different locations.

Learn more

Publishing

Files are represented as components in ftrack. Components can be associated with different entities and represent thumbnails, attachments to notes or files on published versions. Versions (also called asset version) are the main UI representation when publishing files to ftrack.

Learn more

Caching

The Python API makes use of caching in order to provide more efficient retrieval of data by reducing the number of calls to the remote server. You also have the option to add your own custom cache backend for ftrack.

Learn more

Open Source

We proudly make most of our development open source. Check out some of our projects below.

Connect Autodesk Maya with ftrack. Publish and browse files, see and edit task details and write and receive notes and comments in Maya.

Connect NUKE with ftrack. Publish scripts directly from NUKE, import assets and see task details from within NUKE.

Connect MAXON Cinema 4D with ftrack. Access your project, dive into details, publish and import files. All directly from within an easy to use ftrack panel.

See more projects on Bitbucket

Developer news

June 9, 2017 in Developer, Tips & tricks

The Eight VFX Tool: One UI for all

The team at Eight VFX used ftrack to craft their own tool, one that could function as one UI with all the aspects of their applications plugged into it. Thinking…

Read More
August 10, 2016 in Developer, New features, Tips & tricks

Actions, Custom Widgets and JavaScript API – making ftrack better

We’ve invested our efforts and research to ensure that, straight out of the box, the ftrack platform is as powerful as it can possibly be. And what does power mean…

Read More
April 1, 2016 in Developer, New features, Tips & tricks

Advanced filter queries

Hi folks, It’s time for another update from the ftrack dev team. In this blog post we’re going to consider a newly introduced feature that takes the filtering capabilities of…

Read More
February 24, 2016 in Developer, New features, Tips & tricks

API – Introducing paging and sorting

It’s been some time since we released our new API last summer. The API has already seen a broad adoption among our users and we’ve got some really great feedback…

Read More
August 11, 2015 in Announcements, Developer, New features

ftrack 3.2 – Introducing our new API

At ftrack, we know that collaboration is vital to producing great output; individual effort is rarely enough. We extend this viewpoint to our own system: we recognise the importance of…

Read More
April 13, 2015 in Developer, Uncategorized

Write your first ftrack Action

Don’t know what Actions are? Read more about Actions here! You can download sample Actions from our Action repository on Bitbucket. You can also visit the Actions sections on our ftrack…

Read More