Connecting to the WebSocket Server
To interact with a lift, you must establish a connection to the lift via Websockets. This connection requires authentication using an API key and a lift identifier (liftId) to specify the target lift for the session.
info
- Session Management: Each WebSocket connection is scoped to the specified
liftId. Commands and responses are limited to this lift.
WebSocket Connection Details
WebSocket Endpoint
wss://webserver-539540931078.asia-east1.run.app/
Connection Parameters
The WebSocket server requires two arguments in the connection URL:
| Parameter | Type | Required | Description |
|---|---|---|---|
key | String | Yes | API Key for authenticating the connection. |
liftId | String | Yes | Unique identifier for the target lift. |
testing | true or false | Optional | Set to true to connect to a virtual lift for testing |
Connection URL Format
wss://webserver-539540931078.asia-east1.run.app/?key=<API_KEY>&liftId=<LIFT_ID>