Sign InGet Started

Wearables

Withings API

With the Withings API you can connect to your Withings account and retrieve fitness data from your Withings devices. Vital makes it easy to connect to the Withings API and retrieve your data.

Step 1

First steps to integrate with Withings

Create a Vital account

The first step is to create an account with Vital. Once created head to the settings section, and click create API key to start.

Get API Key

Generate a Link Token

Use your API key to generate a link token. This token will be used to allow your users to connect their Withings account.

Link Token Docs

Register Webhook URL

Once connected, register a webhook URL to start receive updates when new Withings data is available. Data is harmonized and sent via JSON.

Read more on webhooks

Step 2

What data does Withings provide?

All data from Withings is provided in JSON format. Vital consists of three main schema types that it uses to push data to your webhook url. These schema types can be found here. You can filter these events to receive specific resource types, via webhook. The full list of available resources for Withings can be found below.

  • activity

  • blood_oxygen

  • blood_pressure

  • body

  • calories_active

  • distance

  • electrocardiogram

  • electrocardiogram_voltage

  • fat

  • heart_rate_alert

  • heartrate

  • hrv

  • hypnogram

  • respiratory_rate

  • sleep

  • sleep_cycle

  • sleep_stream

  • steps

  • vo2_max

  • weight

  • workouts


Withings Webhook Payloads

daily.data.activity.created

daily.data.blood_oxygen.created

daily.data.blood_pressure.created

daily.data.body.created

daily.data.calories_active.created

daily.data.distance.created

daily.data.electrocardiogram.created

daily.data.electrocardiogram_voltage.created

daily.data.fat.created

daily.data.heart_rate_alert.created

daily.data.heartrate.created

daily.data.hrv.created

daily.data.hypnogram.created

daily.data.respiratory_rate.created

daily.data.sleep.created

daily.data.sleep_cycle.created

daily.data.steps.created

daily.data.vo2_max.created

daily.data.weight.created

daily.data.workouts.created

historical.data.activity.created

historical.data.blood_oxygen.created

historical.data.blood_pressure.created

historical.data.body.created

historical.data.calories_active.created

historical.data.distance.created

historical.data.electrocardiogram.created

historical.data.electrocardiogram_voltage.created

historical.data.fat.created

historical.data.heart_rate_alert.created

historical.data.heartrate.created

historical.data.hrv.created

historical.data.hypnogram.created

historical.data.respiratory_rate.created

historical.data.sleep.created

historical.data.sleep_cycle.created

historical.data.steps.created

historical.data.vo2_max.created

historical.data.weight.created

historical.data.workouts.created

Step 3

Receiving Data via Webhooks

Withings data is updated in real-time. Once a user connects their account, you will receive a webhook event with the data. You can also query the data via our API. New data in most cases for Withings is provided in real-time. Vital guarantees all new data to be available within 15 mins of the data being recorded. A refresh for new Withings data can also be requested via our refresh API.

View all Event Payloads
connection

Step 4

integrating-Withings

Historical Harmonized Data

Withings data is always standardized and harmonized using Vital's standardized schemas. This means you can query historical data for any user via HTTP requests and receive historical data prior to connecting devices using Vital. Full list of historical data and how much data is retrieved for Withings can be found below.

Start fetching health data from wearables and lab tests.

SOC 2 Type I

hipaa-icon

HIPAA Certified

GDPR Ready

Product

WearablesLab TestsPricingDocsSupported DevicesBook a testADX instructions