Stream User Sync Status

curl --request GET \
  --url https://api.example.com/api/v1/users/{user_id}/sync/stream \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Sync Status

Stream User Sync Status

Open a Server-Sent Events stream of sync status for a user.

The stream emits event: sync.status messages whose data payload is a JSON-encoded SyncStatusEvent. Heartbeats are sent every ~15 s as SSE comments (lines starting with :) to keep the connection alive across proxies.

Covers events from:

REST pull syncs (e.g. Whoop, Oura, Polar, Suunto)
Garmin webhook live + 30-day backfill
Mobile SDK uploads (Apple HealthKit, Samsung Health, Google)
Apple Health XML imports

The stream remains open until the client disconnects. EventSource in browsers reconnects automatically.

GET

api

users

{user_id}

sync

stream

Stream User Sync Status

curl --request GET \
  --url https://api.example.com/api/v1/users/{user_id}/sync/stream \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Open-Wearables-API-Key

string | null

Path Parameters

user_id

string<uuid>

required

Query Parameters

replay

integer

default:20

Replay last N events on connect.

Required range: 1 <= x <= 200

Response

Server-Sent Events stream of sync status updates.

List Endpoint Attempts List Recent Sync Events