WebSocket Requests

Requests you send to the server. Each is a JSON object with an action and, for most actions, a data object shaped to match it.

whoami action

[Deprecated] Asks the server for your connectionID. Used for the old login process; expect this to be removed or locked down in the future.

The server replies with a whoami event.

This request takes no data.

subscribe action

Asks the server to start sending you events from the given topics. Requires token or key.

The server replies with a subscription-result event listing which topics were accepted.

›topicsreadonly PubSubEventTopic[]

The topics to subscribe to.

›token?string

A complete JWT auth token.

›key?string

A partial token obtained from the Overlay URL, with limited backend access.

Identifies the connecting application, for diagnostics.

rpc action

Invokes an action against a user, almost always their running game session. The action itself is the call object — see RPC calls for the available methods.

›tokenstring

A complete JWT auth token.