Workflow

Workflow is FormTab's automation engine for Submissions. A Workflow runs one or more Actions whenever a chosen event happens on a Form — a Submission is sent, its status changes, or a file finishes uploading. Each Action can be limited to specific Submissions using Criteria, and can be tested against a real Submission before you switch it on.

TIP

Workflow replaced FormTab's older "Triggers" system. If you're looking for the old JSON-based Trigger editor, that's been retired — see Migrating from Triggers below.

Creating a Workflow Action

  1. Go to Forms → Triggers (the sidebar label is still being updated to "Workflow" — this is the same page).
  2. Select the Team you want to configure from the team selector.
  3. Choose Add Action.
  4. On the Configure tab:
    • Give the Action a Name.
    • Choose Fires When — the event that runs this Action (see Events below).
    • Choose an Action type (see Action Types below). The parameter fields shown below the dropdown change depending on the Action type you pick.
    • Fill in the Action's parameters. Text fields that support it show clickable token chips (e.g. Form Field) so you can insert dynamic values from the Submission — see Tokens.
    • Optionally add Criteria to restrict when the Action runs — see Criteria.
    • Set Status to Active or Inactive.
  5. Choose Save Action.
  6. Once saved, use the Preview tab to pick a real Submission and choose Run Preview. This shows whether the Submission would pass your Criteria, and previews the Action's result, without actually sending/posting anything live.

Events

Every Workflow fires on one of the following events:

EventFires when
Form submittedA Submission is sent to the Team
Status changedA Submission's custom status changes
Upload completeAll attachments/photos for a Submission have finished uploading (use this instead of Form Submitted if your Action needs to read attached files or images)

Criteria

Criteria let you restrict an Action to only run for Submissions that match specific conditions, instead of running on every event. If you don't add any conditions, the Action runs on every event.

Choose whether all conditions must match (AND) or any condition can match (OR), then add one or more condition rows, each made up of a field, an operator, and (for most operators) a value.

Fields

The Criteria builder lets you pick from a set of special submission fields, or enter any Form field's label directly:

FieldDescription
Form nameThe name/title of the Form
ReferenceThe Submission's reference
AuthorThe Submission's author/submitter
StatusThe Submission's current status
User refThe user_ref value from the Submission's metadata
Field value…Any Form field, matched by its label

Operators

The Criteria builder currently exposes:

equals, not equals, contains, not contains, starts with, ends with, is empty, is not empty

is empty and is not empty don't require a value.

TIP

The underlying engine also supports greater_than, less_than, in, and not_in for numeric comparisons and matching against a list of values — these aren't in the visual builder yet, but are available if you're configuring criteria via the API.

Example

{
  "operator": "AND",
  "conditions": [
    { "field": "_status", "operator": "equals", "value": "Approved" },
    { "field": "Company", "operator": "contains", "value": "Ltd" }
  ]
}

Tokens

Many Action parameters (email subject, description, tags, webhook URLs, etc.) support tokens — placeholders wrapped in curly braces that are replaced with a real value when the Action runs. Click the token chips shown above a supported field to insert one, or type them directly:

  • {Field Label} — inserts the value of a Form field, matched by its label
  • {_form_name}, {_reference}, {_author} and other _-prefixed metadata tokens — inserts Submission metadata

Action Types

ActionWhat it does
Send EmailEmails a copy of the Submission to one or more addresses
WebhookPOSTs Submission data to an external URL — see the Webhooks Reference
Update DescriptionSets the Submission's description from a template
Update TagsAdds one or more Tags to the Submission (additive — existing Tags are kept)
Set StatusSets the Submission to a specific custom status
Return to SenderSends the Submission back to the original submitter, with an optional message
Assign to UserAssigns the Submission to a Team member for review, with an optional message
Create New SubmissionCreates a new Submission on another Form, optionally copying field values across
Slack NotificationPosts a message to a Slack channel via an Incoming Webhook
Save to DropboxUploads a rendered PDF of the Submission to Dropbox
Save to Google DriveUploads a rendered PDF of the Submission to Google Drive
Save to OneDrive / Add Row to ExcelUploads a rendered PDF to OneDrive, or appends a row to an Excel workbook
Save to SharePoint / Add Row to ExcelUploads a rendered PDF to SharePoint, or appends a row to an Excel worksheet
Create Xero ContactCreates or updates a Contact in Xero from Submission data

Send Email

Sends a copy of the Submission by email.

ParameterDescription
Recipient Email(s)One or more addresses, comma-separated. Supports Field and Group tokens
SubjectOptional, supports tokens, e.g. New submission — {_form_name}
Attachment Formatnone or pdf
Review ModeIncludes a link to the authenticated Team submission viewer. Recipients must be Team members with Reporter or Admin rights
CC AuthorSends a copy to the Submission's author as well

Webhook

POSTs the Submission's data as JSON to a URL you specify.

ParameterDescription
Webhook URLRequired
Payload Version1 (flat key/value) or 2 (grouped, includes callback/verification data)
Custom HeadersOptional key/value pairs sent with the request
Max Retry AttemptsUp to 5
Include Callback URLsAttaches callback URLs to the payload (Version 2 only)

See the Webhooks Reference for the full payload format.

Create New Submission

Copies field values from the current Submission into a new Submission on a different Form — useful for a "Part A → Part B" workflow, where completing one form kicks off a second, fuller form.

ParameterDescription
Target FormThe Team and Form the new Submission should be created on
Assign ToWho the new Submission is assigned to. Supports tokens
Copy ValuesAll Matching Fields (copies by matching field label) or None
Submission DescriptionOptional, supports tokens

Integration Actions

Dropbox, Google Drive, OneDrive, SharePoint, and Xero Actions require you to connect the integration first, under Settings → Integrations. Once connected, the corresponding Action(s) become available in the Action type dropdown.

  • Save to Dropbox / Google Drive / OneDrive / SharePoint — renders the Submission as a PDF and uploads it to a folder you specify (supports tokens for folder path and file name).
  • Add Row to Excel (OneDrive/SharePoint) — appends a row of Submission data to an existing Excel worksheet, matched to existing rows by a configurable column.
  • Create Xero Contact — creates or updates a Xero Contact, using the Contact Name as the upsert key (an existing Contact with the same name is updated rather than duplicated).

Migrating from Triggers

The old Trigger types map onto Workflow Actions as follows. If you have existing Triggers, an administrator can migrate them to Workflow from the Triggers page.

Old Trigger typeNew Workflow Action
Email / Email to Field / Email to GroupSend Email
WebhookWebhook
DescriptionUpdate Description
TagUpdate Tags
Document TriggerCreate New Submission
DropboxSave to Dropbox
XeroCreate Xero Contact
MailChimp SubscribeNo longer available
SharefileNo longer available
ValidateNo longer available as a separate type — use Criteria on any Action instead

Workflow also adds Actions that didn't exist before: Set Status, Return to Sender, Assign to User, Slack Notification, Google Drive, OneDrive, and SharePoint (including Excel row actions).

The old matchon/matchval and conditions fields are replaced by the Criteria builder described above.

Last Updated: