Example Sink

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

Description

Demo sink that counts received messages and logs at debug level. Serves as a template for implementing custom sinks.

Inputs / Outputs

Inputs: (none)
Outputs: (none)

Config aliases

ExampleSink, exampleSink

Properties

No user-facing properties.

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": {
    "exampleSink": {
      "inputEndpoints": [],
      "settings": {}
    }
  }
}

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…