Close node
The Close node ends a branch or the whole journey with a named outcome and a kind (success, failure or neutral) used in insights.
The Close node (code name End) marks where a path of the journey ends and records how it ended. It has No side effects — wire farewell actions upstream. Put any goodbye message or final task before the Close.
Outcomes recorded here feed the journey's Insights; see Health and insights.
When to use it
- At the end of every path, so each patient's run ends with a clear outcome.
- To end the whole journey early, for example when the patient opts out.
- To end one parallel branch while the others carry on.
The builder warns about steps that lead nowhere (has no way forward — a journey that reaches it stops there with no outcome. Connect it onward or to a Close).
Configuration
Field | What it does | Options and default |
|---|---|---|
Label, Notes | See Label and Notes. | — |
Outcome label | The name of the outcome. Outcome label is required at publish | Free text, for example |
Outcome kind | How the outcome counts. Used for analytics rollups | success, failure, neutral (default). |
Scope | What ends. | Branch — siblings continue (default) or Instance — end everything. With Instance: Cancels all other live branches. |
Outcomes and branches
Close has no outgoing connections.
What happens when it runs
- The outcome label and kind are recorded for the patient's run.
- If any step in this run failed, or a Reach step could not deliver one of its messages, a kind of success is recorded as neutral instead. failure and neutral are kept as they are.
- Branch: only this branch ends. Other live branches carry on. When the last branch ends, the run ends.
- Instance: the whole run ends now. Every other live branch and every wait is cancelled.
The patient sees nothing at a Close. Staff see the run's outcome in the Patients tab and in Insights. What happens to tasks that are still open when the run ends is set once for the journey in Journey settings; see Schedulers and journey settings.
Example
Opt-out path.
- A Capture route Opted out leads to a Reach step that confirms the opt-out to the patient.
- The Reach step connects to a Close: Outcome label
opted_out, Outcome kind neutral, Scope Instance — end everything.
Any reminders or routines still running on other branches are cancelled.
Tips and limitations
- Use a small, consistent set of outcome labels across journeys so Insights are easy to compare.
- Choose Instance for any outcome that means the programme is over. With Branch, other branches (for example a Routine) keep the run open.
Last updated on