Skip to content
Relay

Realtime Messages

Realtime messages are 3forge Enterprise's internal messaging protocol, used by feed handlers and client library applications to send and receive data through the Relay.

Overview

External applications communicate with a Relay by connecting to its realtime streaming port, ami.port (default 3289), and exchanging realtime messages: compact, pipe-delimited instructions that add or update objects, delete objects, define commands, and manage the connection lifecycle.

Feed handlers use this same protocol internally to push data into the Relay. Applications that need to send data directly, rather than through a feed handler, typically do so with the client libraries, which implement the protocol on the application's behalf.

Incomplete: full protocol reference not yet documented

The complete message type, parameter, and data-formatting reference is not established in this documentation set yet.