Heartbeats

We send a heartbeat packet every 20 seconds to indicate that connection to the websocket is healthy. If you do not receive a heartbeat, your connection may not be healthy and we would recommend re-connecting.

Heartbeat Object

Field Name

Type

Description

timestamp

time

The time of the heartbeat

eventelementType

string

The type of event, in this case always “heartbeat”

message

string

The heartbeat message

Sample Response

{
    "timestamp": "2017-01-05T17:00:49.087Z",
    "eventElementType": "Heartbeat",
    "message": "Heartbeat sent at 2017-01-05T17:00:49.087Z"
}

Last updated