{
  "client_user_id": "3Zru4O8cBEiwGTsXgUQGaQ==",
  "data": {
    "message": "Due to payload size limits, to access the workout stream, please use the /v2/timeseries/workouts/{workout_id}/stream endpoint.",
    "provider_id": "123dashd9",
    "source": {
      "logo": "https://logo_url.com",
      "name": "Oura",
      "slug": "oura"
    },
    "sport": {
      "id": 1,
      "name": "Running",
      "slug": "running"
    },
    "workout_id": "185d0f34-dfc0-429f-84f9-b24030914bdd"
  },
  "event_type": "daily.data.workout_stream.created",
  "team_id": "e89cc9fe-e1c0-41bc-a83a-728b8cb1056f",
  "user_id": "fac593ed-f371-4aea-9210-9332f1b19bec"
}

Each summary object is uniquely identified by its id.

If multiple events are received at the same id, the last event received replaces all its previous versions.

Properties

event_type
const string
required

Constant: daily.data.workout_stream.created

team_id
string
required
user_id
string
required
client_user_id
string
required
data
ClientFacingShallowWorkoutStream
required
user_id
string
required

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

workout_id
string
required
provider_id
string
required
message
string | null
source
ClientFacingSource
required

Source the data has come from.

provider
string
required

Provider slug. e.g., oura, fitbit, garmin.

type
string | null

The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to unknown when Vital cannot extract or infer that information

app_id
anyOf | null

The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect. Any of:

  • string
  • null
name
string
requireddeprecated

Deprecated. Subject to removal after 1 Jan 2024.

slug
string
requireddeprecated

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

logo
string
requireddeprecated

Deprecated. Subject to removal after 1 Jan 2024.

sport
ClientFacingSport | null

Sport’s name

id
integer
required
name
string
required

Sport’s name

slug
string
required

Slug for designated sport

{
  "client_user_id": "3Zru4O8cBEiwGTsXgUQGaQ==",
  "data": {
    "message": "Due to payload size limits, to access the workout stream, please use the /v2/timeseries/workouts/{workout_id}/stream endpoint.",
    "provider_id": "123dashd9",
    "source": {
      "logo": "https://logo_url.com",
      "name": "Oura",
      "slug": "oura"
    },
    "sport": {
      "id": 1,
      "name": "Running",
      "slug": "running"
    },
    "workout_id": "185d0f34-dfc0-429f-84f9-b24030914bdd"
  },
  "event_type": "daily.data.workout_stream.created",
  "team_id": "e89cc9fe-e1c0-41bc-a83a-728b8cb1056f",
  "user_id": "fac593ed-f371-4aea-9210-9332f1b19bec"
}