•••
 
Documentation   /   Building workflows   /   The workflow editor
 
 

The workflow editor

 

Open a workflow from Toolkit → Workflows. The editor has these tabs:

Tab What it's for
Workflow The visual editor. Add, edit, move and connect actions.
Code The same workflow as text. Edit it directly, copy it or paste a whole workflow in.
Settings → Basic Name, description, workgroup, public or private, and whether to share with your group.
Settings → Extra fields The launch form: fields completed when a task starts.
Settings → Advanced Advanced workflow settings, such as background tasks and duplicate detection.
Developer The workflow's start link and API key. See Starting and managing tasks.

Visual editor and code editor

The two editors show the same thing. Changes in one appear in the other.

  • The visual editor is the easiest way to start. Each action has a form for its common settings.
  • The code editor exposes every directive, including ones without a form field. Some actions, such as Wait, SMS and the document actions Get, Include, Update and Delete, are only available through code or the Input code action.

Structure of workflow code

Workflow code is a list of items. Each item starts with --#item: on its own line, followed by directive lines. Leave a blank line between items.

--#item:
---id:first_step
---title:First step
---action:done
---outcome:second_step

--#item:
---depends_on:first_step
---id:second_step
---title:Second step
---action:done

Rules:

  • Each directive is on one line: three hyphens, the directive name, a colon, then the value.
  • To put a line break inside a value, such as an email body or a description, write ~~~.
  • Item IDs and aliases use lowercase letters, numbers and underscores, such as check_salary_2.
  • The order of items in the code is the order they're shown in a task, among the items that are showing.
  • Text written above the first item, followed by a line containing only [[CHECKLIST]], becomes the task's introduction.

See Workflow actions for every directive.

Settings: Basic

Setting What it does
Workflow name Shown in lists and when starting a task.
Workflow description Explains what the workflow is for.
Workgroup Limits the workflow (and its tasks) to one workgroup. If blank, anyone in your account can use it.
Public Public lets people outside your account complete tasks. Private means only your team can view and complete them.
Make available to your whole group Shares the workflow with the other accounts in your group.

When you copy a workflow, you can also copy the templates it uses.