unsubscribe websocket

This block is part of the websocket group and was last modified in core v13.0.5.

unsubscribe websocket condition v13.0.5

Unsubscribes the websocket from a specific channel.

In pins 4 + flow

flow
flow
channels required
array
Hidden when other fields are filled
channel required
value
Hidden when other fields are filled
events
array
The events to unsubscribe from. If you owuld like to unsubscribe from all events within this channel, leave this array empty or provide * as one of the values.
Default ["*"]
skip jwt required
condition
Skips the broadcast of subscriptions to the frontend. If set to true, the frontend will not be able to resubscribe on the channels where the broadcast was skipped.
Default false

Out pins 3 + flow

flow
flow
success
condition
error
value
channels
array

Unsubscribes the current WebSocket connection from the given channels (channels array and channel pin merged, duplicates removed); the channels out pin lists the channels actually unsubscribed. Scoped to the events list when wired, all events when empty. success=false with error MISSING_CHANNELS when no channel resolves or MISSNG_WEBSOCKET (sic) when there is no connection; does nothing in simulation. Unless skipjwt is true, the new subscription set is broadcast to the frontend.

A typical wiring for unsubscribe websocket: a function trigger starts the flow; with values feeds the channels pin; value feeds the channel pin; the flow out pin feeds debug.

Version history

Introduced in v13.0.5.

Back to websocket Return to the main group to view all sub-groups Back to websocket Return to the group to view all blocks within this group