Read Heart Rate via WebSocket

This method allows reading the heart rate of the user in real-time. The WebSocket connection can be interrupted at any point in time, make sure to have retry logic with backoff. To pass the OAuth access token query parameter access_token is used.

Request

name	value
url	wss://dev.pulsoid.net/api/v1/data/real_time
scope	data:heart_rate:read

Query Parameters explained:

name	type	description
access_token	string	Used to path auth token in WebSocket request

Websocket URL Request Example

wss://dev.pulsoid.net/api/v1/data/real_time?access_token=8c4da3ce-7ed7-4a19-a1f1-058498661e45

WebSocket Message Example

{
  "measured_at": 1625310655000,
  "data": {
    "heart_rate": 40
  }
}

Websocket URL Request Example With response_mode=text_plain_only_heart_rate

wss://dev.pulsoid.net/api/v1/data/real_time?access_token=8c4da3ce-7ed7-4a19-a1f1-058498661e45&response_mode=text_plain_only_heart_rate

WebSocket Message Example With response_mode=text_plain_only_heart_rate

123

---