Events
Broadcast event
Events
Broadcast event
Use this action to broadcast an event to a room. This is a server-side action that can be called outside of a specific Liveblocks room.
🔐 Plus Plugin Only: This is only available in the Plus version of the plugin. Get the Plus plugin here.
Fields
The following fields are available in this action:
| Field | Type | Description |
|---|---|---|
| Room ID | Text | The ID of the room where the event will be broadcasted. |
| Type | Text | The type of event being broadcasted. |
| Message | Text | The message payload that accompanies the event. |
Returned Values
The following values are returned by the action:
| Value | Type | Description |
|---|---|---|
| Error | Boolean | Indicates whether an error occurred during the action. |
| Message | Text | Displays an error message if one occurred. |
| Status | Number | The error code if the action failed. |