RUAL Documentation

subscribe websocket on backend

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

subscribe websocket on backend v13.0.5

Subscribes the websocket to a specific channel. All broadcasts will be handled in the backend.

Pin Pin Type Default
flow
flow
channels
Multiple channels you would like the server to subscribe / listen on
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
on broadcastrequired
The callback function requested whenever we received any event on any of the given channels
execute_function
success
Indicates if we could start subscribing at all, true could indicate we subscribed to one of the many given channels.
condition
error
value
channels
Channels we succesfully subcribed to
array

Core Releases

v13.0.5 This block was introduced in v13.0.5, 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