RUAL Documentation

subscribe websocket on frontend

This block is part of the websocket group and was last modified in core v10.4.28.

subscribe websocket on frontend v10.4.28

Subscribes the websocket to a specific channel. All broadcasts will be pushed to that spark / the frontend.

Pin Pin Type Default
flow
flow
channelsrequired
array
channel
A channel you would like the server to subscribe / listen on
value
events
Listen on the provided events. If you would like to listen on all events within this channel, leave this array empty or provide * as one of the values.
array ["*"]
skip jwt
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.
condition false
Pin Pin Type Example
flow
flow
success
condition
error
value
channels
array

Core Releases

v10.4.28 This block was introduced in v10.4.28, click here to see the release notes.
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