Vital home pagelight logo
Summaries
daily.data.workout_stream.created

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_typerequired
const string

Constant: daily.data.workout_stream.created

datarequired
ClientFacingShallowWorkoutStream
user_idrequired
string

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.

user_key
string | null

[⚠️ Deprecated] User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.

workout_idrequired
string
provider_idrequired
string
message
string | null
sourcerequired
ClientFacingSource

Source the data has come from.

namerequired
string

Name of source of information

slugrequired
string

Slug for designated source

logorequired
string

URL for source logo

sport
ClientFacingSport | null

Sport’s name

idrequired
integer
namerequired
string

Sport’s name

slugrequired
string

Slug for designated sport

​
Examples

{
  "event_type": "daily.data.workout_stream.created",
  "data": {
    "workout_id": "c89ed19d-894d-4047-a308-5de37971e086",
    "provider_id": "123dashd9",
    "message": "Due to payload size limits, to access the workout stream, please use the /v2/timeseries/workouts/{workout_id}/stream endpoint.",
    "source": {
      "name": "Oura",
      "slug": "oura",
      "logo": "https://logo_url.com"
    },
    "sport": {
      "id": 1,
      "name": "Running",
      "slug": "running"
    }
  }
}