Event

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

{
    'topic': 'unique-event-topic',
    'data': {
        # The data payload of the event.
    },
    'source': {
        # Information about the source of the event
        # (application id, current user etc).
    },
    'target': 'optional-target-expression'
}

note

Individual Clients may implement their own event wrappers/helpers.

Event server

All events, except special synchronous ones, are routed through a central event server.

Connections to the event server are handled with WebSocket using socket.io. Events are always transmitted as JSON encoded packets under the ftrack.event namespace.