Go to step
Audience:
Low-code EngineersSkill Prerequisites:
Actions,User Guides
Moves the user to a step you choose in the guide they're following. Use it on a step's button to jump ahead, go back to the start, or branch to a different part of the guide. The current step is marked as done, and the chosen step is shown.
This action is only available in User Guides.
Typical Use Cases
- A Start over button that goes back to the first step
- A Skip button that jumps past optional steps
- Branch a guide, with one button per path, for example I'm new and I've done this before
Don't use it to
- Move to the next or previous step. Use Next step or Previous step, which also skip steps that don't apply to the user.
- End the guide. Use Finish guide.
Related Actions
| Action Name | Description |
|---|---|
| Next step | Moves to the next step that applies to the user. |
| Previous step | Moves to the previous step that applies to the user. |
| Finish guide | Marks the guide as finished and closes it. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Step | The step to go to, chosen from the steps of the current guide. It's saved as the step's ID. | No | empty | Yes |
Considerations
- The step's condition isn't checked. The chosen step is shown even if its Condition is false or it's disabled.
- If the step no longer exists, for example because it was deleted, the action shows the error Invalid step!. Check the action after changing a guide's steps.
- Progress is saved per user. The current step is marked Done in the user's step history, and the chosen step becomes their current step.
- The guide must be running for the user, so use it on a step's buttons.
- The step is shown right away, so actions after this one on the same button don't run.
Examples
tip
To understand how to use the below examples, please see Running Examples.
1. Start over
Add this action to a Start over button. After importing, choose the first step in Step, because step IDs are different on every site.
{
"Title": "Go to step",
"ActionType": "GoToStep",
"Description": "Go back to the first step",
"Parameters": {
"Step": ""
}
}
Revised 09/27/2026