Skip to main content
Version: 1.28 (Current)

Finish guide

Audience: Low-code Engineers

Skill Prerequisites: Actions, User Guides

Marks the guide as finished for the user and closes it. Use it on the last step's button, typically one labeled Done or Finish.

This action is only available in User Guides.

Typical Use Cases​

  • The Done button of a guide's last step
  • A Don't show this again button on any step, to end the guide early

Don't use it to​

  • Hide the guide for now but let the user continue later. Finishing records that the user completed the guide.
  • Move to another step. Use Next step or Go to step.
Action NameDescription
Next stepMoves to the next step.
Previous stepMoves to the previous step.
Go to stepMoves to a step you choose.

Input Parameter Reference​

This action has no parameters.

Considerations​

  • Progress is saved per user. The current step is marked Done, and a Finished entry is added to the user's step history for the guide.
  • The guide must be running for the user, so use it on a step's buttons.
  • The guide closes 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. Done button​

Add this action to the last step's Done button.

{
    "Title": "Finish guide",
    "ActionType": "FinishGuide",
    "Description": "Finish the guide",
    "Parameters": {}
}

Revised 09/27/2026