Events
Manages events
Last updated
Manages events
Last updated
Checks the health of the events service. Returns 'OK' and a status code of 200 if the service is healthy.
Provides information about the service status.
Provides information about the service status.
The ID of the event to delete
Default Response
Returns all the events, both public and private, that a user has permission to access. An event will only include the necessary data needed to launch the event, under the 'launchContext' field, if it is live.
The response for GET /events, an array of all events a user has permission to access
The ID of the world that the user will enter upon launching the event
The URL of the thumbnail for the event
Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.
Defines custom data of an arbitrary shape you can use to store any data you want
Defines the data needed to launch into the world linked to the event
The ID of a project
The ID of the event to update
The picture url of an event
Returns all publicly visible events for an organization without requiring authentication, where a public event is one in which the isPublic
field on the event is set to true
The response for GET /events/public, an array of public events
The ID of the world that the user will enter upon launching the event
The URL of the thumbnail for the event
Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.
Defines custom data of an arbitrary shape you can use to store any data you want
Whether the user can write to the event
The ID of a project
The ID of the event to update
The URL of the thumbnail for the event
Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.
Default Response
Creates an event in the organization specified in the headers
The ID of the world that the user will enter upon launching the event
The URL of the thumbnail for the event
Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.
Defines custom data of an arbitrary shape you can use to store any data you want
The response for POST /events, an eventId representing the created event
The ID of the created event
Returns the launchContext for an event, which defines all the data needed to launch the event, either by downloading the world or by launching the world in a browser.
ID of the target event for launch context retrieval
The response when retrieving a launch context linked to an event
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out
^https?://.*$
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully
^https?://.*$
Defines whether the launch context is live
Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.
Defines whether the event is publicly accessible or not. If true, the event can be launched by a user regardless of their permissions.
The ID of the world that the user will enter upon launching the event
Returns the event with the given ID. This endpoint will only return the necessary data needed to launch the event under the 'launchContext' field if it is live.
The ID of the event to retrieve
The response for GET /event/:eventId endpoint
The ID of the world that the user will enter upon launching the event
The URL of the thumbnail for the event
Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.
Defines custom data of an arbitrary shape you can use to store any data you want
Defines the data needed to launch into the world linked to the event
The ID of a project