provider.connection.created

Lab Tests

Orders
Results
Appointments

Provider

Summaries

Activity
Body
Meal
Menstrual Cycle
Profile
Sleep
Sleep Cycle
Workout
Workout Stream

Activity Timeseries

Calories Active
Calories Basal
Distance
Floors Climbed
Steps
VO2 Max
Workout Duration

Vitals Timeseries

Blood Pressure
Blood Oxygen
Cholesterol
Electrocardiogram Voltage
Glucose
IGE
IGG
Insulin Injection
Heart rate
HRV
Respiratory Rate

Body Timeseries

Body Fat
Body Weight
Body Temperature
Body Temperature Delta

Diary Timeseries

Note

Nutrition Timeseries

Caffeine
Carbohydrates
Water

Wellness Timeseries

Mindfulness Minutes
Stress Level

event_type

enum<string>

required

Available options:

provider.connection.created

user_id

string

required

client_user_id

string

required

team_id

string

required

data

object

required

data.user_id

string

required

data.source

object

requireddeprecated

Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.

Example:

{
  "logo": "https://logo_url.com",
  "name": "Oura",
  "slug": "oura"
}

data.provider

object

required

A vendor, a service, or a platform which Vital can connect with.

Example:

{
  "logo": "https://logo_url.com",
  "name": "Oura",
  "slug": "oura"
}

data.resource_availability

object

required

Example:

{
  "provider": {
    "logo": "https://logo_url.com",
    "name": "Fitbit",
    "slug": "fitbit"
  },
  "resource_availability": {
    "body": {
      "scope_requirements": {
        "user_denied": { "optional": [], "required": [] },
        "user_granted": { "optional": [], "required": ["weight"] }
      },
      "status": "available"
    },
    "sleep": {
      "scope_requirements": {
        "user_denied": {
          "optional": [
            "heartrate",
            "oxygen_saturation",
            "respiratory_rate"
          ],
          "required": ["sleep"]
        },
        "user_granted": { "optional": [], "required": [] }
      },
      "status": "unavailable"
    }
  },
  "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}

labtest.appointment.updated provider.connection.error

{
  "event_type": "provider.connection.created",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "provider": {
      "logo": "https://logo_url.com",
      "name": "Fitbit",
      "slug": "fitbit"
    },
    "resource_availability": {
      "body": {
        "scope_requirements": {
          "user_denied": {
            "optional": [],
            "required": []
          },
          "user_granted": {
            "optional": [],
            "required": [
              "weight"
            ]
          }
        },
        "status": "available"
      },
      "sleep": {
        "scope_requirements": {
          "user_denied": {
            "optional": [
              "heartrate",
              "oxygen_saturation",
              "respiratory_rate"
            ],
            "required": [
              "sleep"
            ]
          },
          "user_granted": {
            "optional": [],
            "required": []
          }
        },
        "status": "unavailable"
      }
    },
    "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
  }
}