Actions83
- AI Copilot Actions
- AI Knowledge Actions
- Attachment Actions
- Comment Actions
- Feed Actions
- Group Actions
- Inbox Actions
- Room Actions
- Storage Actions
- Thread Actions
- User Actions
- Delete Inbox Notification
- Get Inbox Notification
- Delete All Inbox Notifications
- Get Many Inbox Notifications
- Delete Notification Settings
- Get Notification Settings
- Update Notification Settings
- Delete Room Subscription Settings
- Get Room Subscription Settings
- Update Room Subscription Settings
- Get Many Room Subscription Settings
- Yjs Actions
Room → Broadcast Event
AI-generatedSummary
Send a JSON payload as a broadcast event to all clients connected to a specified Liveblocks room.
Inputs
- Room ID (required) — The identifier of the Liveblocks room to which the event will be broadcast.
- Body — Any JSON payload to send as the broadcast event's content.
- Include Request in Error — Optionally include detailed request information in error messages to aid debugging if the API call fails.
Output shape
a JSON object reflecting the API response to the broadcast event request
The returned data contains the server acknowledgment or error details if broadcasting fails. Errors may optionally include the outgoing request details if enabled by 'Include Request in Error'.