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

Each row shows the setting’s label in the node’s Properties panel and, in code, its key in the node’s settings object in the config file. A setting omitted from the config file uses the default shown here.

Example node definition

A minimal entry in config.json looks like the block below. Paste it under the sinks key, keyed by an instance name of your choice. All settings are optional: anything not listed under settings uses the default from the Properties table above. See The configuration file for how the sections and endpoint wiring work.

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