•••
 
Documentation   /   Actions   /   Actions overview
 
 

Actions overview

 

An action is one step in a workflow, set with ---action:{action_name}. This page lists every action. The pages that follow cover each group in detail, and Workflow actions gives the directives that apply to all of them.

Documents

Action Name in the editor What it does Shown to user
specific_document Make document (manually) The user creates a document from a template, entering its details. Yes
auto_document Make document (automatically) Plainly creates a document, and can lock, send or finalise it. Yes
copy_document Copy a document Creates a new document from an existing one. Yes
get_document (code only) Fetches an existing document, shows it and imports its data. Yes
include_document (code only) Imports an existing document's data. No
update_document (code only) Changes variables in an existing document. No
delete_document (code only) Deletes a document. No

See Document actions.

Questions and inputs

Action Name in the editor What it does
question Multiple choice question Asks a question with predefined answers, shown as buttons.
text_input Text input Asks for text, a longer passage or an amount. Can validate the format.
dropdown Dropdown Asks the user to choose from a dropdown list.
date Date Asks for a date.
attachment Attach a file Asks for a file to be attached to the task.
done (code only) A to-do with a "Done it!" button.

See Question and input actions.

Communication

Action Name in the editor What it does
notify Send an email Shows a prepared email for the user to review and send.
auto_email Auto email Sends an email automatically. Hidden from users.
sms (code only) Sends a text message automatically.

See Communication actions.

Flow control

Action Name in the editor What it does
stop Blocker Holds back later items until earlier ones are done.
wait (code only) Waits for a period of time, or until a date.
hidden Hidden Sets a value without showing anything. Used to calculate and pass data.
text_output Output text Shows text, images or documents.
redirect Redirect Sends the user to a URL.
kill Kill the task Ends the task. It can't be restarted.
include (code only) Inserts all the items from another workflow.

See Flow control actions.

Integrations

Action Name in the editor What it does
payload Send a payload Sends a POST, PUT or GET request to a URL and can save the response.
hook Receive a payload Waits for another system to send in a value.

See Integration actions.

Input code

The Input code action in the visual editor lets you type an item's code directly. Use it for actions marked "code only" above, and for any directive the forms don't show.