Realtime Send Node
Push a message to peers connected over WebSocket.
Overview
Realtime Send pushes a message to browsers connected to a WebSocket room, for example to update a live chat, a dashboard or a notification badge. Delivery happens in the runtime and does not consume a workflow run.
Configuration
| Field | Description | Default |
|---|---|---|
Room |
The room to send to. Leave empty to reply into the room the trigger message came from | - |
Recipients |
Who gets the message (see below) | Whole room |
Message |
Text or JSON. Supports {{variables}} |
- |
Output Variable |
Holds delivered, room, room_exists and peers |
delivery |
Recipients
| Option | Who receives it |
|---|---|
Whole room |
Everyone connected to the room, including the peer whose message triggered the flow |
Others |
Everyone except that peer. Useful when relaying rather than replying |
Connections |
Only the listed connection ids: one browser tab rather than every session of an account |
Identities |
Every connection of the listed users, so a person is reached on all their open tabs |
Advanced
| Field | Description |
|---|---|
Endpoint Path |
Only needed when the workflow has more than one WebSocket trigger |
Event Name |
Clients switch on this. Defaults to message |
Sender Identity |
How the message is attributed, for example system |
Handling nobody being online
{{delivery.delivered}} is 0 when nobody is connected. That is a normal outcome, not an error. Branch on it with a Condition node and fall back to email or a push notification.