Skip to main content
A simple heartbeat mechanism to verify WebSocket connection health. This request is available even without any subscription.
Prefer this application-level ping message over WebSocket control frames when validating connectivity. Because it is handled as a normal data message, it confirms end-to-end reachability across the same path used by your subscriptions and requests.

​
Request

{
  "message": "ping",
  "content": {
    "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a"
  }
}
FieldTypeRequiredDescription
messagestringYesping
content.clientRequestIdstringNoClient-generated UUID for correlation

​
Response

{
  "resultType": "pong",
  "data": {
    "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a",
    "statusCode": 200
  }
}
FieldTypeRequiredDescription
resultTypestringYespong
data.clientRequestIdstringNoClient-generated UUID for correlation
data.statusCodenumberYes200