Connecting to the WebSocket Server

To interact with a lift, you must establish a connection to the lobby via WebSockets. This connection requires authentication using an API key and a lobby identifier (lobbyId) to specify the target lobby for the session.

info

• Session Management: Each WebSocket connection is scoped to the specified lobbyId. Commands and responses are limited to this lobby.

---

WebSocket Connection Details

WebSocket Endpoint

wss://api.liftauth.com/v2

Connection Parameters

The WebSocket server requires arguments in the connection URL:

Parameter	Type	Required	Description
lobbyId	String	Yes	Unique identifier for the target lobby.
testing	true or false	Optional	Set to true to connect to a virtual lobby for testing

Connection Headers

The Websocket server requires headers to authenticate the connection:

Header	Type	Required	Description
Authorization	String	Yes	API Key for authenticating the connection.

Connection URL Format

wss://api.liftauth.com/v2?lobbyId=<LOBBY_ID>