A live event can perform a variety of actions relevant to running and watching the event. This document explains how you can manage and retrieve information on live events in a Sendbird application using the Sendbird Live Platform API.
The following tables show the list of properties in a live event resource.
A unique ID of the live event.
Indicates a type of host for the live event. A valid value is
The timestamp of when the live event was created, in Unix milliseconds.
The timestamp of when the live event was set to ready, in Unix milliseconds.
The timestamp of when the live event was started, in Unix milliseconds.
The timestamp of when the live event ended, in Unix milliseconds.
The state of the live event. Valid values are the following:
Indicates whether the host is streaming their media while the live event is in the
The ID of the user who created the live event. If the live event is created by the Platform API, an empty string will return.
The ID of the user who sets the live event to
The ID of the user who started the live event. If the live event is started by the Platform API, an empty string will return.
The ID of the user who ended the live event. If the live event is ended by the Platform API, an empty string will return.
The period from when the live event was created to when the live event was ended, in milliseconds.
The user who is the host of the live event.
The number of participants in the live event which is counted by the number of devices and browsers concurrently connected to the Sendbird server.
The highest number of
The sum of all participants that entered and exited the live event.
array of strings
An array of IDs of the users who can be the host for the live event. This property can have up to 10 user IDs.
The title of a live event. The length is limited to 191 characters.
The URL of the cover image for the live event. The length is limited to 2,048 characters.
- API endpoints are relative to the base URL allocated to your application. In this page, the
/live-eventsendpoint refers to
Note: To get your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.
- It's recommended that the parameter values in API URLs be URL encoded, such as
List of actions