Sign in

v3

latestOpenAPI 3.1.02026-07-31121144224.9 KB
External: 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/v1/users/{user_id}/sync/stream

Path parameters

user_idstring uuid required

Query parameters

replayinteger

Replay last N events on connect.

Replay last N events on connect.

Headers

X-Open-Wearables-API-Keystring nullable

Response

Server-Sent Events stream of sync status updates.