Reference
initialize
Initialize the WebSocket session using an environment API key and a stable client_id.
initialize
Initialize the WebSocket connection and bind it to an application environment.
- Type:
1 - Requires initialization: no (this is the initialization step)
- Requires authorization: no
Request and response example
initialize
Bind the socket session to an application environment.
Request fields
| Field | Type | Required | Meaning |
|---|---|---|---|
id | uint64 | yes | Request id. |
socket_api_key | string | yes | Environment API key from the dashboard. |
client_id | string | yes | Stable device/machine identifier. |
Response fields
| Field | Type | Meaning |
|---|---|---|
id | uint64 | Your request id. |
app_name | string | Application name resolved from the API key. |
app_version | string | Application version (as configured in the dashboard). |
status | int | ok (1) or an error code. |
Common statuses
| Status | Meaning |
|---|---|
1 | ok |
2 | invalid_socket_api_key |
4 | client_id_missing |
11 | client_id_blacklisted |
6 | internal_server_error |