Sign in
Room

Broadcast event to a room

Changed on

This endpoint enables the broadcast of an event to a room without having to connect to it via the client from @liveblocks/client. It takes any valid JSON as a request body. The connectionId passed to event listeners is -1 when using this API. Corresponds to liveblocks.broadcastEvent.

post/rooms/{roomId}/broadcast-event

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/rooms/{roomId}/broadcast-event
  • Auth: none declared

Path parameters

roomIdstring required

ID of the room

Example:my-room-id

Request body

unknown required

Response

Success. An event was broadcast to the room.

Changes