onboarding::progress::get
Read an operator’s tour progress: per tour, the status of every step and the trigger evidence that closed it, plus which tour to offer next.
- subjectstring
- next_tour_idstringrequired
- subscribed_atnumber
- toursobjectrequired
onboarding
v0.1.18Guided console tour — step content, per-operator progress in state, and an injected page that spotlights the console element each step talks about.
Install
bash
iii trigger compose::add worker=onboarding@0.1.18Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.
Functions7
Function
onboarding::steps::complete
Mark one tour step complete. Pass `fired` when a trigger closed it — its type and payload are kept as the evidence the tour shows back.
- firedobject
- function_idstring
- payloadunknown
- trigger_typestring
- step_idstringrequired
- subjectstring
- tour_idstringrequired
- stepobjectrequired
onboarding::steps::reset
Forget every step of one tour, so it starts from the beginning again.
- subjectstring
- tour_idstringrequired
- resetbooleanrequired
onboarding::subscribe
Add an email address to the iii product-update list, and record the signup time (not the address) on the subject’s progress as `subscribed_at`.
- emailstringrequired
- sourcestring
- subjectstring
- subscribedbooleanrequired
onboarding::tours::get
Fetch one tour by id with every step: id, title, body, and the CSS anchor the console page spotlights for that step.
- idstringrequired
- tourobjectrequired
onboarding::tours::list
List every available tour in curriculum order with its id, title, description, and step count. Call this to find out what onboarding content exists.
Empty object
- toursunknown[]required
onboarding::ui-content
Serve the injectable onboarding console page assets.
- pathstringrequired
- contentstringrequired
- content_typestringrequired
Triggers0
No triggers registered