WebSocket Sink

Node ID: websocketSink · Role: Sink · Realtime config: no

Description

Starts a WebSocket server that streams pipeline data as JSON to any connected clients. Useful for feeding live data to browsers, dashboards, or custom web clients.

Inputs / Outputs

Inputs: (none)
Outputs: (none)

Config aliases

WebsocketSink, websocketSink

Properties

The following fields are exposed in the node’s Properties panel in the UI. Types map to UI widgets (e.g. string → text input, number → numeric, boolean → toggle, select → dropdown, json → JSON editor).

Key	Label	Type	Default	Description / Notes
`port`	Port	`number`	`8080`	TCP port the WebSocket server listens on.

Example node definition

A full node definition in config.json looks like the block below. Paste it under the sinks key of your config, keyed by the node’s instance name (any identifier; it doesn’t have to match the node ID).

{
  "sinks": {
    "websocketSink": {
      "inputEndpoints": [],
      "settings": {
        "port": 8080
      }
    }
  }
}

Field reference

Field	Purpose
`inputEndpoints`	List of upstream endpoints this node connects to (`outEndpoint` / `dataEndpoint` values from upstream nodes).
`inputDataFilter`	Optional whitelist of data types. Messages whose type isn’t in the list are dropped at the subscriber.
`settings`	All user-configurable fields — see the Properties table above.

Connections can also be declared at the top-level connections array when settings.explicitConnections is true, as an alternative to filling inputEndpoints on each node.

Loading documentation…