Skip to main content

getting-started

A Step-by-Step Guide

Getting Started with Automations​

info

Building, editing, and enabling automations requires the Platform Admin role. The person who created the organization has this role.

  1. Accessing the Automation Builder

    • Navigate to the "Automations" tab under the "Settings" menu.

  2. Creating a New Automation

    • Click "New" to initiate the automation creation process.
    • You will be prompted to choose a starting point. You can select a pre-built Template (like "Intake Form Assignment" or "New Patient Welcome") to jumpstart your workflow, or choose Start from Scratch to build a custom flow.

  3. Using the Visual Builder

    • Automations are built using an interactive visual flowchart.
    • Click on the Trigger node at the top to define what event initiates the automation (e.g., a schedule, or a resource being created/updated).
    • Give your automation a meaningful Name and Description in the editor header.

  4. Adding Filters and Actions

    • Click Add Event Filter in the toolbar to add a filter node.
    • Click Add Action or Add Wait in the toolbar, or click the + button on the lines between nodes, to add Action or Wait steps.
    • Note: Event Filters are hidden for recurring triggers. For other trigger types, filters must be added from the toolbar.
    • Add Filter nodes to refine the conditions for the trigger.
    • Add Action nodes to perform tasks like sending messages, creating resources, or assigning forms.
    • Add Wait nodes to pause the automation for a specific duration before executing the next step.

  5. Programming the Steps

    • Click on any node in the canvas to open its configuration panel on the right side of the screen.
    • Utilize the forms in the panel to set the necessary variables, templates, and recipients for that specific step.

  6. Completing Your Automation

    • Once you have configured all the nodes in your flow, click "Save" to finalize your automation.

  7. Enabling Your Automation

    • Use the Enabled toggle in the editor header to turn the automation on.
    • The toggle can only be enabled when all of the following are true:
      • There is at least one action in the flow.
      • A segment is chosen, when the trigger audience is a segment.
      • Every Assign Form step has a form selected.
    • The slider will turn blue when the automation is enabled.
    • You can also locate your enabled automation in the "Active" tab when viewing the automations section.

With the visual builder and starter templates, you can quickly create custom automations tailored to your specific needs and objectives, enhancing the efficiency and functionality of your system.