Workflow Node Reference

Last updated 8 days ago

This page describes every workflow node type, what it does, and what you can configure when it is selected in the Workflow Builder. Use it as a lookup reference when reading, editing, or building a workflow.

Flow control nodes

Flow control nodes manage the timing and direction of a workflow run. They determine when the workflow pauses, which path it follows, and when it ends.

The flow control node types are:

Trigger

The Trigger node is the first node in every workflow. It defines the event that starts the workflow run for a specific contact. Every workflow has exactly one Trigger node and it cannot be removed.

Trigger Event dropdown options:

Category

Trigger event

Description

Manual

Manual

A staff member manually starts the workflow for a specific contact. No additional configuration is required.

Audience

Contacts: Created

A new contact record is created

Audience

Contacts: Updated

A contact record is updated

Audience

Contacts: Added to Segment

A contact is added to a segment

Audience

Contacts: Removed from Segment

A contact is removed from a segment

Audience

Form: New Submission

A contact submits a form

Audience

Form Request: Completed

A form request sent to a contact is completed

Commerce

Subscription: Created

A new subscription is created

Default

E-Sign: Document Completed

A document is signed by the contact

Default

E-Sign: Document signed by Party

A specific party signs a document

Task

Task: Completed

A task assigned to a staff member is completed

Care Plan

Care Plan: Created

A contact is enrolled in a care plan

Care Plan

Care Plan: Task Completed

A task within a care plan is completed

Care Plan

Care Plan: All Phase Tasks Completed

All tasks in a care plan phase are completed

Care Plan

Care Plan: Phase Status Changed

A care plan phase changes the business status

Additional trigger event types may be available in your account. Use the "Search events..." bar in the dropdown to find a specific event by name.

Wait Until

The Wait Until node pauses the workflow run for a set amount of time before continuing to the next node. Use it when you want the workflow to wait a fixed period, such as sending a follow-up message 24 hours after the first.

The Type setting controls how the delay is defined. It defaults to Duration but can be changed to Day & Time.

When Type is set to Duration:

Setting

Description

Duration

The length of time to wait before continuing. Enter a plain text value, for example 30m, 3 hours, or 2.5d. Maximum delay is 30 days.

Time

An optional time of day for the workflow to resume once the duration elapses. If left blank, the run continues immediately when the duration expires. If a time is set, the workflow resumes at that hour on the expiration date. If that hour has already passed, it resumes at that hour on the following day.

When Type is set to Day & Time:

Setting

Description

Day

The day of the week on which the workflow should resume.

Time

The time of day on the selected day at which the workflow should resume.

At all times, use your organization's configured timezone.

After configuring the node, click Apply Changes to save the settings.

Wait For Event

The Wait For Event node pauses the workflow run and waits for a specific event to occur. It has two outputs:

  • On Event: the workflow takes this path when the event fires within the configured time window.

  • On Timeout: the workflow takes this path when the time window expires before the event occurs.

Both the On Event path and the On Timeout path must continue to at least one more node or an Exit Workflow node.

Configuration options:

Setting

Description

Event

The trigger event to wait for. Select from the same event types available in the Trigger node. Some event types show a Configure Event section below with additional fields.

Wait Mode

How the workflow behaves once the condition is met. Immediate continues the run as soon as the event occurs or the timeout is reached. Sleep pauses execution until the specified time period elapses after the event or timeout.

Timeout

The maximum time to wait for the event. Enter a plain text value, for example 30m, 3 hours, or 2.5d. Defaults to 1 day.

After configuring the node, click Apply Changes to save the settings.

Paths

The Paths node splits the workflow into two or more branches based on conditions you define. Each branch leads to a different set of subsequent nodes, so the workflow can take different actions for different contacts.

Every Paths node has a Fallback path by default. The Fallback path runs for any contact that does not match any defined condition. Every branch, including the Fallback, must connect to at least one more node or an Exit Workflow node.

Each condition path has the following configuration:

Setting

Description

Label

A name for this path branch, shown on the canvas output dot.

Type

The rule type for this branch. Set to Condition for standard conditional logic.

Source

The data source to evaluate. Set to Workflow Value to check values produced earlier in the run.

Only continue if

The condition rule. Specify a Workflow Value to check, a Condition operator (for example, equals or contains), and a Compare Value to match against.

To add more AND conditions within a path, click + And. To add an OR group (a separate set of conditions evaluated independently), click + Add "Or" rule group. To add more condition paths to the node, click Add Condition at the top of the panel.

After configuring the node, click Apply Changes to save the settings.

Exit Workflow

The Exit Workflow node ends the current workflow run for the contact. No configuration is required. Every path in a workflow should end with an Exit Workflow node so that it runs cleanly.

The node can also be configured to trigger another workflow for the same contact immediately after the current run ends. To do this, select the next workflow in the configuration panel before clicking Apply Changes. If no next workflow is selected, the run simply exits.

Action nodes

Action nodes perform the work of the workflow: sending messages, assigning tasks, updating contact records, and more. A workflow can contain any number of action nodes in any order.

The action node types covered in this section are:

Send Message

The Send Message node sends an SMS message to the contact in the workflow.

Configuration options:

Setting

Description

Recipient

The contact to send the message to. Defaults to "Workflow contact" (the contact the workflow is currently running for).

Message

The SMS content. Type a message directly, insert a saved message template using the template toolbar button, add contact data using the personalization {} toolbar button, or attach a file, form, or link using the attach toolbar button. Maximum 1,530 characters.

After configuring the node, click Apply Changes in the configuration panel to save the settings before saving the canvas.

Send Email

The Send Email node sends an email to the contact in the workflow using a saved email template.

Configuration options:

Setting

Description

Email subject

The subject line of the email.

Email template

The saved email template to send. Select from the list or use the search bar to find a template by name.

After configuring the node, click Apply Changes to save the settings.

Assign Task

The Assign Task node creates a new task and assigns it to a staff member. Use this node when a step in the workflow requires a human response, such as reviewing a form answer or following up with a patient by phone.

Configuration options:

Setting

Description

Title*

The title of the task.

Description*

A description of the task. Both fields support basic text formatting.

Status*

The initial status of the task. Defaults to Requested.

Priority*

The priority level of the task. Defaults to Routine.

For

Who the task is created for. Set to Workflow Contact to use the contact the workflow is running for, or Manual to select a specific person.

Performer

Who should perform the task. Set to Workflow Contact or Manual to select a specific staff member.

Time to Complete

The time offset until the task is due. Select a preset or enter a custom value such as 30m, 5h, or 1d.

Fields marked with an asterisk (*) are required. After configuring the node, click Apply Changes to save the settings.

Add Resource to Task

The Add Resource to Task node attaches a resource to a task that was created earlier in the same workflow run. The assigned staff member can then open the task and access the attached resource before taking action.

Configuration options:

Setting

Description

Task ID*

The task to attach the resource to. Select the task ID output from an earlier Assign Task node in the same run.

Resource Type*

The type of resource to attach, for example, Form Submission.

Resource ID*

The specific resource to attach. Select the resource ID output from an earlier node in the run.

After configuring the node, click Apply Changes to save the settings.

Add Tag

The Add Tag node adds one or more tags to the contact's record. Adding a tag can automatically move the contact into any segment that uses that tag as a condition, which may in turn trigger other workflows.

In the Add Tags field, select the tags to add from the list. You can select multiple tags in a single node. After configuring the node, click Apply Changes to save the settings.

Remove Tag

The Remove Tag node removes one or more tags from the contact's record. Removing a tag can automatically remove the contact from any segment that uses that tag as a condition.

In the Remove Tags field, select the tags to remove from the list. You can remove multiple tags in a single node. After configuring the node, click Apply Changes to save the settings.

Create Form Request

The Create Form Request node creates a form request for the contact to complete. The contact typically receives the form link via SMS.

In the Form field, select the form to send to the contact. Use the search bar to find a form by name. After configuring the node, click Apply Changes to save the settings.

Additional nodes

The following nodes are available in the action picker for more specialized use cases.

Node

Usage

Send Notification

Sends an SMS notification to a selected staff member. Delivered during the recipient's working hours.

Update Contact Details

Updates one or more fields on the contact's record with specified values.

Create Contact

Creates a new contact record using standard and custom field values.

Assign Contact to Team

Assigns the contact to one or more teams.

Unassign Contact from Team

Removes the contact from one or more teams.

Assign Task From Template

Creates a care plan task from a task template within a specific care plan phase.

Invite to Portal

Invites the contact to the patient portal.

Create E-Sign Document

Creates a signature request from a document template and assigns signer roles for each party.

Get Form Submission

Retrieves a form submission from an earlier step in the same workflow run.

Query Contact

Searches for a contact record using a specified field value, such as a phone number.

Update Task

Updates the status or performer of a task created earlier in the workflow run.

Create Care Plan

Enrolls the contact in a care plan.

Update Care Plan Status

Updates the status of an active care plan.

Update Care Plan Phase Status

Updates the status of a specific phase within a care plan.

Get Phase Tasks

Retrieves the tasks associated with a care plan phase.

Get Phase Task

Retrieves a specific care plan task by its ID.

Related articles

Now that you have the full node reference, check these related articles to put it into practice.

  • Create a Workflow: Step-by-step instructions for building a new workflow from scratch, from selecting a trigger event to activating the workflow.

  • Workflows in Subflow: Concept overview explaining what workflows are, how they are triggered, and how they relate to care plans.

  • Manage Workflows: How to view, edit, enable, disable, and archive workflows from the Active Workflows list.