Skip to content

Health

Health data and workouts.

import Health;

endWorkout

Ends the active workout on your Apple Watch.

endWorkout(IntentAppDefinition: Text)
ParameterTypeDefault
IntentAppDefinitionText[object Object]

Shortcuts action: is.workflow.actions.workout.end

findHealthSamples

findHealthSamples()

If you only see some but not all of your data in the results, make sure that “Allow Shortcuts to read data” is set to on in the Health app.

Shortcuts action: is.workflow.actions.filter.health.quantity

getDetailsOfHealthSample

getDetailsOfHealthSample()

Shortcuts action: is.workflow.actions.properties.health.quantity

logHealthSample

Adds a data point into the Health app. You can log anything that the Health app supports, including your weight, steps taken, running distance, caloric intake and more.

logHealthSample(WFQuantitySampleType: Text, WFQuantitySampleQuantity: Number, WFQuantitySampleAdditionalQuantity: Number, WFQuantitySampleAdditionalEnumeration: Text, WFCategorySampleEnumeration: Text, WFCategorySampleAdditionalEnumerationKey: Text, WFQuantitySampleDate: Text, WFSampleEndDate: Text) -> Any
ParameterTypeDefault
WFQuantitySampleTypeText
WFQuantitySampleQuantityNumber
WFQuantitySampleAdditionalQuantityNumber
WFQuantitySampleAdditionalEnumerationText
WFCategorySampleEnumerationText
WFCategorySampleAdditionalEnumerationKeyText
WFQuantitySampleDateText
WFSampleEndDateText

Shortcuts action: is.workflow.actions.health.quantity.log

logWorkout

Adds a workout into the Health app. You can log all kinds of activities, from running and cycling to playing a sport.

logWorkout(WFWorkoutReadableActivityType: Text, WFWorkoutDate: Text, WFWorkoutDuration: Number, WFWorkoutCaloriesQuantity: Number, WFWorkoutDistanceQuantity: Number) -> Any
ParameterTypeDefault
WFWorkoutReadableActivityTypeText
WFWorkoutDateText
WFWorkoutDurationNumber
WFWorkoutCaloriesQuantityNumber
WFWorkoutDistanceQuantityNumber

Shortcuts action: is.workflow.actions.health.workout.log

startWorkout

Starts a workout on your Apple Watch.

startWorkout(IntentAppDefinition: Text, workoutName: Text, isOpenEnded: Boolean, WorkoutGoal: Number)
ParameterTypeDefault
IntentAppDefinitionText[object Object]
workoutNameText
isOpenEndedBooleantrue
WorkoutGoalNumber"15"

Shortcuts action: is.workflow.actions.workout.start