KinesteX

Plan Context

Pass plan progression context so the SDK associates a directly launched workout with the correct plan. Applies to: Workout view (a workout launched directly that should count toward a plan). After the workout finishes, the SDK posts plan_progression_saved (or plan_progression_failed on error). See Plans & Programs events.


ParameterTypeApplies toWhat it does internally
planIdstringWorkout viewThe ID of the plan the workout belongs to, used on the results screen to resolve the plan and record progression against it. A ?planId= on the /workout/{id} URL wins over the launch value
planTypestringWorkout view"personalized" or "goal-based". Selects which progression pipeline records the completion (and the matching results screen)
progressWorkoutIdstringWorkout viewThe plan-day workout ID used to record progression when the route does not carry a workout ID

When to use: only when you launch a workout directly through the SDK (not through the in-app plan UI) and want it to count toward plan progression. The in-app plan flow handles this itself.


Progression is only recorded for a meaningful session: personalized-plan progression requires a minimum efficiency score, and goal-based progression requires some completed work (several reps or about 10s of hold time). A workout abandoned at once does not advance the plan.


Note: a workout launched without these fields is a standalone session and does not update plan progression.

Plan Context Configuration
Swift example:
1kinestex.createWorkoutView(
2    workout: "Day 3 Workout",
3    user: nil,
4    style: nil,
5    isLoading: $isLoading,
6    customParams: [
7        "planId": "plan_abc123",
8        "planType": "personalized",
9        "progressWorkoutId": "plan_day_3"
10    ],
11    onMessageReceived: { message in /* ... */ }
12)