[COMMAND]

Ending a Session

The session_end command is used to manually close an active WebSocket connection.

Typically this is used to facilitate a user's request to end their session; sessions will end naturally after a short period of inactivity (approx. 30 seconds), but it's best to manually close a connection as soon as it is no longer needed.

Parameters

reason
optional
string

A brief description of why the connection ended, for auditing purposes.

Example Request

Copy
{"command":{"command_type":"session_end", "reason":"Finished batch changes."}}

Responses

On Success:

Successfully ending the current session will cause a session_end_result to be returned.