Skip to content

WSS Overview

WSS connections are limited to a 10 minute idle connection timeout. We recommend using the WSS ping method below to keep a connection alive. The maximum length of any WSS connection is 2 hours, after that the device will be disconnected and need to reconnect as needed.

All WSS requests are bundled into a WSS JSON payload exampled below. The action parameter is similar to a REST API resource or endpoint, the method parameter is similar to a REST API HTTP method, and the data parameter contains a string or object with the message payload.

Generic Example Request

Example:

json
{
  "action": "WSS Action",
  "method": "Request Method",
  "data": "Request Body"
}