Guide

Audience: Low-code Engineers

Skill Prerequisites: Actions, User Guides

The Guide actions work with user guides. Four of them go on the buttons of a guide's steps and move the user through the guide: forward, back, to a step you choose, or to the end. The fifth, Import Guide, creates or updates a whole guide from JSON.

Choosing an action

Action	What it does	Use it to
Next step	Marks the current step as done and shows the next step that applies to the user.	Add a Next button to a step.
Previous step	Marks the current step as not done and shows the previous step that applies to the user.	Add a Back button to a step.
Go to step	Marks the current step as done and shows the step you choose.	Add a Start over or Skip button, or branch the guide.
Finish guide	Marks the guide as finished for the user and closes it.	Add a Done button to the last step, or a Don't show this again button.
Import Guide	Creates a guide from JSON, or updates the guide with the same title.	Install or update an application's guides from a setup workflow.

Where they run

• Step actions. Next step, Previous step, Go to step and Finish guide are only available in User Guides. Use them on a step's buttons, while the guide is running for the user. They show the new step, or close the guide, right away, so actions after them on the same button don't run.
• Import Guide is available in all modules, such as Forms, Listings, API endpoints and workflows. It requires the Guides feature to be licensed. If it isn't, the action fails with a not-licensed error. The actions after it keep running.

Moving between steps

• Conditions. Next step and Previous step skip steps whose Condition is false, or that are disabled. Go to step shows the chosen step even if its condition is false or it's disabled.
• First and last steps. Next step shows No next step when there's no step left, so use Finish guide on the last step. Previous step shows No previous step on the first step, so don't add a Back button there.
• Progress is saved per user. Each step action updates the user's step history. After Next step, the user continues from the new step the next time the guide is shown. Finish guide records that the user completed the guide, so don't use it to hide a guide the user should continue later.

Importing and step IDs

Go to step saves the chosen step's ID. Import Guide matches existing steps by position, so after an import a Go to step action may point to a different step, or show Invalid step! if the step was deleted. Check these actions after you import or change a guide's steps.

Revised 10/02/2026