WebSocket events

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

The events system in ftrack works by clients subscribing to events they are interested in and a central service routing published events accordingly.

Whilst there are several built-in events it is also possible for clients to publish their own custom events and reuse the event framework for custom purposes.

More information:

• Event handling in our Python client
• Event handling in our JavaScript client

Overview

📄️ Event

An event is a standardized mapping structure that follows the form:

📄️ Publishing events

You can either publish standard ftrack events or leverage the event framework to publish your own events. In either case, once connected to the event server, you simply need to send an event of the appropriate form to the server under the ftrack.event namespace.

📄️ Subscribing to events

To listen to events, you register a subscription with the central event server. You do this by publishing special meta events:

📄️ Events list

The following are standard ftrack events published by the server. Each heading refers to the ‘topic’ the event is published with. Each entry includes an example of the event (relevant information only).