blazeauth
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

FieldTypeRequiredMeaning
iduint64yesRequest id.
socket_api_keystringyesEnvironment API key from the dashboard.
client_idstringyesStable device/machine identifier.

Response fields

FieldTypeMeaning
iduint64Your request id.
app_namestringApplication name resolved from the API key.
app_versionstringApplication version (as configured in the dashboard).
statusintok (1) or an error code.

Common statuses

StatusMeaning
1ok
2invalid_socket_api_key
4client_id_missing
11client_id_blacklisted
6internal_server_error

On this page