Skip to main content

User journeys

A user journey is one participant's enrolment in a journey: the version it runs, the node they are at, and a log of every node entered and action taken. The server keeps the official one; the phone predicts it between syncs.

Starting​

  • Staff or a journey assign any published journey. Staff can choose the version; a journey that chains starts the published one. A participant already enrolled in the journey is started over by staff and left where they are by a chain.
  • A participant can start a journey with explore: shown themselves (otherwise journey_not_self_enrollable), always on the published version. A start made offline is sent later with startedAt, when it was made.
  • On joining, a participant is started on each of the tenant's default journeys that is published; see Tenants.
  • Archived journeys can't be assigned.

The start node runs straight away. A staff assignment whose start node fails is refused, so the person assigning sees it.

Pausing and ending​

A user journey is active, paused, completed (it reached an end node) or archived, and records when it entered each. Staff, and a journey's own actions, move any user journey to any status. A participant can pause, resume and archive only a journey they started themselves (journey_not_self_changeable), and only the server's runner completes one.

  • Paused, the journey stands still: no nodes, waits or chains. A wait it was in carries on with the time it had left when it resumes, and every clock the journey reads skips the pause.
  • Completed or archived, it stops for good: no more nodes, waits or chains. Everything it already assigned stays as it stands, answered or not.

progress on the journey (shown or hidden) decides whether it has a row on the participant's Progress tab, in any state.

The log​

Each user journey's events (listUserJourneyEvents) record what happened and when: the version pinned at each assignment, every node entered, every action run or skipped with the reason. When a participant didn't get what you expected, read the log before the journey.