Import Guide

Audience: Low-code Engineers

Skill Prerequisites: Actions, User Guides, JSON

Creates a user guide from JSON, or updates an existing guide with the same title. Use it to install or update guides from actions, for example when you set up an application on a new site.

Unlike the other Guide actions, this one is available in all modules, such as Forms, Listings, API endpoints and workflows.

note

This action requires the Guides feature to be licensed. If it isn't, the action fails with a not-licensed error.

Typical Use Cases

• Install an application's guides as part of a setup or update workflow
• Update a guide on several sites from the same JSON
• Restore a guide from a saved copy

Don't use it to

• Move a guide once by hand. Use Export guide and import on the User Guides settings screen instead.
• Start or show a guide to a user. Guides are shown by their triggers.

Related Actions

Action Name	Description
Run SQL Query	Can load the guide JSON from a table into a token.
Server Request	Can download the guide JSON from another site or a repository.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Guide JSON	The guide to import, in the same JSON format that Export guide produces. Token values are inserted as they are, so you can pass the whole JSON in a token.	Yes	empty string	Yes
Update existing Guide if matched by Title	When checked, a guide with the same Title is updated instead of a new one being created. When unchecked, a new guide is always created, even if one with the same title exists.	No	Unchecked	No

How updating works

With Update existing Guide if matched by Title checked, the action looks for a guide whose title matches the JSON's Title. If there are several, it uses the first one.

The guide is updated in place and keeps its ID. Its triggers and steps are matched by position: the first step in the JSON updates the first existing step, the second updates the second, and so on. If there's no guide with that title, a new one is created.

Considerations

• Import the same JSON twice, and you get two guides, unless Update existing Guide if matched by Title is checked.
• Don't reorder steps between versions. Because steps are matched by position, reordering them in the JSON updates the wrong steps and can mix up users' progress.
• Steps referenced by ID, for example in Go to step, may point to a different step after the import. Check them afterwards.
• The action doesn't return anything, and the actions after it keep running.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Install or update a guide from a token

This action imports the guide JSON held in the GuideJson token, for example loaded earlier with Run SQL Query, and updates the guide if it's already installed.

{
    "Title": "Import Guide",
    "ActionType": "ImportGuide",
    "Description": "Install or update the onboarding guide",
    "Parameters": {
        "GuideJson": "[GuideJson]",
        "UpdateByTitle": true
    }
}

Revised 09/27/2026