Holds back every item listed after it until the items before it meet a condition. Items after a Blocker don't need ---depends_on. Use it to bring parallel or branching items back together.
| Directive | Required | Description |
|---|---|---|
| ---options | No | What to wait for (see below). Default: done_at. |
| ---block | Yes | Always true. |
| Option | Releases the Blocker when... |
|---|---|
| done_at | every showing item before it is done |
| document_key({item_id}) | that item has created a document |
| document_sent({item_id}) | that item's document has been sent |
| skipped({item_id}) | that item has been skipped |
--#item: ---id:all_checks_done ---title:Waiting for all pre-employment checks ---action:stop ---options:done_at ---block:true
Waits for a period of time, then lets the workflow continue.
| Directive | Required | Description |
|---|---|---|
| ---options | Yes | {number} {minutes|hours|days|months|years} FROM {timestamp}. The timestamp can be {{*now}} or a date variable. |
| ---block | Yes | true. |
| ---optional | Recommended | true, so a user can skip the wait if needed. |
--#item:
---depends_on:offer_sent
---id:wait_a_week
---title:Waiting a week before chasing
---action:wait
---options:7 days FROM {{*now}}
---block:true
---optional:true
---outcome:chase
Sets a value without showing anything. Use it to calculate, combine or rename values, or to branch on a condition.
| Directive | Required | Description |
|---|---|---|
| ---answer | Yes | The value. Can use variables and logic statements. |
| ---done_at | Yes | 1, so it completes immediately. |
--#item: ---id:needs_approval ---action:hidden ---answer:[[IF=salary(GREATER_THAN £60000)]]yes[[ELSE]]no[[ENDIF]] ---done_at:1 ---filter1|filter:answer EQUALS yes ---filter1|outcome:director_approval ---filter2|filter:answer EQUALS no ---filter2|outcome:send_offer
--#item:
---id:full_name
---action:hidden
---answer:{{first_name}} {{surname}}
---done_at:1
The API can also set a Hidden item's answer. See API: Doing task actions.
Shows text, images or links in the task, such as instructions, a summary or a thank-you message.
| Directive | Required | Description |
|---|---|---|
| ---title | Yes | Heading. |
| ---description | Yes | The text. Supports variables, logic statements and ~~~ line breaks. |
| ---done_at | Recommended | 1, so it doesn't hold up the task. |
Sends the user to a URL when they reach this point. Use it to finish a public form on your own website or on a payment page.
| Directive | Required | Description |
|---|---|---|
| ---options | Yes | The URL. Can include variables. |
| ---done_at | Yes | 1. |
Ends the task immediately and prevents any further actions. A killed task can't be restarted.
| Directive | Required | Description |
|---|---|---|
| ---options | No | The reason, recorded on the task. |
| ---block | Yes | true. |
--#item: ---depends_on:right_to_work ---id:stop_hiring ---title:Can't proceed ---description:We can't employ someone without proof of right to work. ---action:kill ---options:No right to work ---block:true
Inserts every item from another workflow at this point. Use it to share a common set of steps, such as standard IT setup, between workflows.
| Directive | Required | Description |
|---|---|---|
| ---options | Yes | The key of the workflow to include. |
--#item:
---id:it_setup
---action:include
---options:{workflow_key}
Only one level of inclusion is supported: Include items inside the included workflow are ignored. The included workflow's item IDs must not clash with your own.