> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lindy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Step by Step Onboarding

> Create form-style onboarding flows that make your agent templates easy to configure and use.

<div style={{ display: 'flex', justifyContent: 'center', margin: '2rem 0' }}>
  <div className="video-card">
    <video src="https://mintcdn.com/lindyai/QWdJNkViLsD1veyH/lindy-brand-assets/sbso.mp4?fit=max&auto=format&n=QWdJNkViLsD1veyH&q=85&s=e924a54e425df589ff3fab1eb06ca7b5" width="600" autoPlay muted loop playsInline style={{ display: 'block', width: '100%', borderRadius: '16px' }} data-path="lindy-brand-assets/sbso.mp4" />
  </div>
</div>

## Quick Overview

Step-by-Step Onboarding enables you to easily onboard others to an agent template. Instead of requiring template users to navigate a complex flow editor, build a simple form-style onboarding that allows your template users to easily configure and start using the agent!

<Tip>
  Try it yourself: [Meeting Notetaker Step by Step Onboarding template](https://chat.lindy.ai/home?templateId=670444478279e010c572da9a)
</Tip>

<Frame>
  <img src="https://mintcdn.com/lindyai/D9TqHMLRoGnnvrcz/lindy-brand-assets/SBSO1.avif?fit=max&auto=format&n=D9TqHMLRoGnnvrcz&q=85&s=f661f481012fbe349573903e33f89e97" alt="Step-by-Step Onboarding" width="1600" height="840" data-path="lindy-brand-assets/SBSO1.avif" />
</Frame>

Key benefits:

* **Simplified setup** — Form-style interface instead of complex flow editor
* **Guided configuration** — Step users through only the essential settings
* **Professional experience** — Clean, intuitive onboarding flow
* **Automatic auth handling** — User authorizations collected automatically
* **Template sharing** — Easy distribution with built-in onboarding

## Creating a Step by Step Onboarding

This is the high-level process for creating a Step by Step Onboarding:

### Step 1: Plan Your Requirements

**Input Collection**
Figure out what input you need to collect from your users to configure the agent template.

*Example: Meeting Notetaker Template*

* Required: Calendar selection (required field)
* Optional: 'Restrict by attendee type' configuration

**Output Display**
Determine what output you need to show users so they can use the template.

*Example: Meeting Scheduler Template*

* Output: User's Lindy Mail address for CC'ing to email threads

### Step 2: Build the Onboarding Flow

Build the onboarding flow in the Flow Editor using:

* **Form Actions** — Show information and collect input
* **Lindy Configuration Actions** — Configure template steps

<Note>
  All Step by Step Onboardings start with an `Onboarding trigger` from Lindy Configuration Actions (located under `Lindy Utilities`).
</Note>

<Frame>
  <img src="https://mintcdn.com/lindyai/QWdJNkViLsD1veyH/lindy-brand-assets/sbso4.avif?fit=max&auto=format&n=QWdJNkViLsD1veyH&q=85&s=7d60823cef58fe10922e67cf8cd97cd2" alt="Step-by-Step Onboarding Trigger" width="1557" height="585" data-path="lindy-brand-assets/sbso4.avif" />
</Frame>

<Tip>
  User authorizations are automatically collected at the beginning of onboarding. You do not need to collect user auths as an onboarding step.
</Tip>

### Step 3: Test and Share

<Frame>
  <img src="https://mintcdn.com/lindyai/QWdJNkViLsD1veyH/lindy-brand-assets/sbso-test.png?fit=max&auto=format&n=QWdJNkViLsD1veyH&q=85&s=c2d4782e270e2934d8be6827436c908f" alt="Step-by-Step Onboarding Test" width="3080" height="1804" data-path="lindy-brand-assets/sbso-test.png" />
</Frame>

1. Click **Test** in the upper right corner
2. Select the onboarding trigger
3. Make changes if necessary
4. Share your template

## Form Actions

Form Actions enable you to show information and collect input from users:

| Action                       | Purpose                                                         |
| ---------------------------- | --------------------------------------------------------------- |
| **Show Multiple-Choice**     | Shows a multiple choice question to users and collects input    |
| **Show Copyable Content**    | Shows a piece of text ready to copy                             |
| **Show Info Step**           | Shows information to template users                             |
| **Show Text Input**          | Shows a question to users and collects long or short text input |
| **Show Copyable Embed Code** | Shows the code snippet of a Lindy embed to copy                 |

<Note>
  Each step has an 'illustration' field. If no file is uploaded, there will be a default illustration.
</Note>

## Lindy Configuration Actions

Located within Lindy Utilities in the action modal, these actions allow you to collect input from users while configuring template steps:

### Collect User Input to Configure Step

Collects input from a user for a specific field and uses the values to update the configuration of the fields in a step.

<Warning>
  You cannot configure AI Agents or condition steps. Use Configure Step for these instead.
</Warning>

### Configure Step

Collects input from a user for a step and updates the configuration of any step. Use this over "Collect User Input to Configure Step" if:

* There are multiple fields in a step that you want to configure
* You need to configure AI Agents or condition steps

### Configure Lindy Embed

Configures the Lindy embed trigger node.

### Configure Knowledge Base

Collects data sources for a knowledge base node.

### Get User Info

Gets a user's information, including:

* Name
* Email
* Time Zone
* Lindy Mail Suffix

## The Step by Step Onboarding Experience

### User Flow

<div style={{ display: 'flex', justifyContent: 'center', margin: '2rem 0' }}>
  <div className="video-card">
    <video src="https://mintcdn.com/lindyai/VHBHJwXMXFd-cbnu/lindy-brand-assets/continue-sbso.mp4?fit=max&auto=format&n=VHBHJwXMXFd-cbnu&q=85&s=faf0e746e75ad7dc4c21de22b44dd9db" width="600" autoPlay muted loop playsInline style={{ display: 'block', width: '100%', borderRadius: '16px' }} data-path="lindy-brand-assets/continue-sbso.mp4" />
  </div>
</div>

* **Incomplete onboarding**: Users who click out without completing will land on the Flow Editor for the template and can resume onboarding
* **Completed onboarding**: Users are redirected to the Task View for the agent they just configured

### Harmonious Experience

To ensure a smooth experience, add a `Message Received trigger` to your template with a greeting message that introduces your user to the Lindy.

## Best Practices

<AccordionGroup>
  <Accordion title="Start with Introduction">
    Begin with an Info Step introducing your user to the agent they will be onboarded to and what it does.
  </Accordion>

  <Accordion title="End with Next Steps">
    In the last step, let the user know that the agent can be configured further in the Flow Editor.
  </Accordion>

  <Accordion title="Add Welcome Message">
    Add a Message Received trigger to your template with a greeting message. Users will see this after completing onboarding.
  </Accordion>

  <Accordion title="Consider Simple Templates">
    If the agent consists of only a Message Received trigger and an agent state, onboarding may not be needed. Consider using a Show Info step to tell the user how to use the agent.
  </Accordion>

  <Accordion title="Focus on Essentials">
    When thinking of inputs and outputs, consider what is required for the user to configure to ensure the agent can run, and critical steps that the user might want to configure.
  </Accordion>
</AccordionGroup>

<Warning>
  Template users will not be able to see the onboarding flow in their template's Flow Editor after sharing.
</Warning>

## Next Steps

Enhance your template sharing with these concepts:

<CardGroup cols={2}>
  <Card title="Templates" href="/fundamentals/lindy-101/templates" icon="clipboard-list">
    Learn about creating and sharing agent templates
  </Card>

  <Card title="Test Panel" href="/testing/test-panel" icon="play">
    Test your onboarding flows thoroughly
  </Card>

  <Card title="Lindy Embed" href="/skills/by-lindy/lindy-embed" icon="message-dots">
    Embed Lindy chat widgets in websites
  </Card>

  <Card title="Knowledge Base" href="/fundamentals/lindy-101/knowledge-base" icon="database">
    Configure knowledge bases for support templates
  </Card>
</CardGroup>