Workflows

Workflows Module

The Workflows module allows users to automate actions based on specific events in the system. Users can create workflows, select a trigger, configure workflow steps, and manage the workflow status.

Workflows Overview


1. Workflows Overview

The Workflows page displays all available workflows and provides options to search, filter, create, and manage workflows.

Workflows Overview

1.1 Workflow Status

StatusDescription
AllDisplays all workflows available in the system.
ActiveDisplays workflows that are currently active.
PausedDisplays workflows that are currently paused.
DraftsDisplays workflows that are saved as drafts and are not yet configured or activated.

1.2 Workflow List

Workflow List

Column / OptionDescription
NameDisplays the name of the workflow.
TriggerDisplays the event that starts the workflow.
StepsDisplays the number of configured workflow steps.
RunsDisplays the number of times the workflow has been executed.
StatusDisplays the current status of the workflow.
ToggleAllows the workflow to be enabled or disabled when applicable.
DeleteAllows the workflow to be removed.
Search workflowsAllows users to search for a specific workflow by name.
New workflowOpens the workflow creation form.

2. Search Workflows

The Search workflows option allows users to quickly find a specific workflow from the workflow list.

Search Workflows

Steps

  1. Open the Workflows module.
  2. Locate the Search workflows field.
  3. Enter the workflow name or relevant search text.
  4. The workflow list is filtered based on the entered search text.
  5. Select the required workflow to view or manage it.

3. View Workflows by Status

Workflows can be viewed based on their current status.

Steps

  1. Open the Workflows module.
  2. Select the required status tab.
  3. The workflow list displays workflows belonging to the selected status.
StatusDescription
AllDisplays all workflows.
ActiveDisplays workflows that are currently active.
PausedDisplays workflows that are currently paused.
DraftsDisplays workflows that are still in draft status.

4. Create a New Workflow

The New workflow option allows users to create a new automation workflow.

Steps

  1. Open the Workflows module.
  2. Click New workflow.
  3. The New workflow pop-up is displayed.

New Workflow

  1. Enter the required Workflow name*.
  2. Enter a Description, if required.
  3. Select the required Customer Scope.
  4. Select the event that should trigger the workflow.
  5. Review the selected trigger.
  6. Click Create & configure.

5. New Workflow Fields

New Workflow Fields

Field / OptionDescription
Workflow name*Enter the name of the workflow. This field is mandatory.
DescriptionEnter an optional description explaining the purpose of the workflow.
Customer ScopeDefines whether the workflow applies to all customers or a specific customer.
Work order createdStarts the workflow when a work order is created.
Work order closedStarts the workflow when a work order is closed.
WO status changedStarts the workflow when the status of a work order changes.
Request submittedStarts the workflow when a request is submitted.
Asset status changedStarts the workflow when an asset status changes.
Inventory low stockStarts the workflow when inventory reaches a low-stock condition.
Warranty expiringStarts the workflow when a warranty is approaching its expiry.
Checklist completedStarts the workflow when a checklist is completed.
Soft point readingStarts the workflow based on a soft-point reading event.
CancelCloses the pop-up without creating the workflow.
Create & configureCreates the workflow and continues to workflow configuration.

6. Select a Workflow Trigger

The When should this run? section allows users to select the event that starts the workflow.

6.1 Available Triggers

TriggerDescription
Work order createdStarts the workflow when a new work order is created.
Work order closedStarts the workflow when a work order is closed.
WO status changedStarts the workflow when a work order status changes.
Request submittedStarts the workflow when a request is submitted.
Asset status changedStarts the workflow when an asset status changes.
Inventory low stockStarts the workflow when inventory reaches a low-stock condition.
Warranty expiringStarts the workflow when a warranty is approaching its expiry.
Checklist completedStarts the workflow when a checklist is completed.
Soft point readingStarts the workflow based on a soft-point reading event.

Steps

  1. Open the New workflow pop-up.
  2. Enter the Workflow name.
  3. Select the required Customer Scope.
  4. Locate When should this run?.
  5. Select the required trigger.
  6. Review the trigger details.
  7. Click Create & configure.

7. Work Order Created Trigger

The Work order created trigger starts the workflow whenever a new work order is created.

Steps

  1. Open the Workflows module.
  2. Click New workflow.
  3. Enter the required Workflow name*.
  4. Enter a Description, if required.
  5. Select the required Customer Scope.
  6. Under When should this run?, select Work order created.
  7. Review the trigger information.
  8. Configure the required conditions.
  9. Click Create & configure.

7.1 Trigger Details

OptionDescription
Work order createdStarts the workflow whenever a new work order is created.
If priority = criticalAllows the workflow to continue only when the work order matches the selected priority condition.
Assign to Senior TechExample action that automatically assigns the work order to a technician.
Notify ManagerExample action that notifies a manager.
Alert Safety TeamExample action that notifies the safety team.

7.2 Conditions

ConditionDescription
Only when priority isFilters the workflow based on work order priority.
Only when work type isFilters the workflow based on work type.
Only for siteLimits the workflow to a selected site.
Only for locationLimits the workflow to a specific location within the selected site.
Condition ValueDescription
AnyApplies the workflow regardless of the selected value.
PrioritySelect the priority that should trigger the workflow.
Work typeSelect the work type that should trigger the workflow.
SiteSelect the site where the workflow should apply.
LocationSelect a location after selecting the required site.

Note: The available condition options depend on the selected trigger.


8. Configure Workflow Steps

After creating the workflow, the workflow configuration page is displayed.

Workflow Configuration

The selected trigger, such as Work order created, is displayed at the top of the workflow.

8.1 Add a Workflow Step

  1. Locate the + icon below the workflow trigger.
  2. Click the + icon.
  3. The Add a step pop-up is displayed.
  4. The pop-up provides different Actions and Control Flow options.
  5. Select the required step based on the workflow requirement.

Workflow Add Step

8.2 Available Actions

Workflow Add Step Actions

ActionWhat it does
Send notificationSends a notification to a selected person or team.
Send emailSends an email to the required recipient.
AssignAssigns the work to a person or team.
Update fieldChanges the value of a selected field.
Create work orderAutomatically creates a new work order.
Create taskAutomatically creates a task.
Attach checklistAttaches a checklist template to the work order.
Copy request attachmentsCopies attachments from the source request to the work order.
Approve / decline requestAutomatically approves or declines the source request.
WebhookSends an HTTP request to an external URL.
Switch (route by value)Routes the workflow to different steps based on a field value.

8.3 Available Control Flow Options

Available Control Flow Actions

Control FlowWhat it does
ApprovalRequests approval from a person.
ConditionBranches the workflow based on a condition.
If / ElseCreates different workflow paths based on a condition.
Wait / DelayPauses the workflow for a specified period.
Escalation timerWaits and escalates if a condition remains unmet.
Repeat untilRepeats an action until the specified condition is met.

9. Send Notification Configuration

When Send notification is selected from the Add a step pop-up, the notification configuration panel is displayed. Scroll through the panel to configure all available notification settings.

Workflow Send Notification Configuration

9.1 Send Notification Fields

SectionField / OptionDescription
GeneralStep labelDefines the name of the workflow step. The default value is Send notification.
NotificationChannel*Selects how the notification should be delivered. The available options are Push, Email, and In-app.
RecipientRecipients*Selects the person who should receive the notification. Click Add recipient... to select a recipient.
RecipientDynamic recipientsAllows the workflow to determine the actual recipient when the workflow runs.
TemplateTemplateDefines the notification template. Custom message can be selected to create a custom notification.
SubjectSubject (optional)Defines the notification or email subject. Workflow values can be used dynamically in the subject.
MessageFormatDefines how the notification message is formatted. The available options are Plain text and Markdown.
MessageMessageContains the main notification content that will be sent to the selected recipient. Workflow values can be included dynamically.
PreviewPreviewDisplays a sample preview of the notification using sample values.

9.2 Notification Configuration

SectionField / OptionDescription
Notification ChannelPushSends the notification as a push notification.
Notification ChannelEmailSends the notification through email.
Notification ChannelIn-appDisplays the notification inside the application.
Recipient ConfigurationAdd recipient...Selects the person who should receive the notification.
Recipient ConfigurationDynamic recipientAllows the recipient to be determined automatically when the workflow runs.
Template ConfigurationTemplateSelects the notification template to use.
Template ConfigurationCustom messageAllows the user to create the notification content manually.
Subject ConfigurationSubject (optional)Defines the notification or email subject.
Subject ConfigurationWorkflow valuesAllows dynamic workflow values to be included in the subject where supported.
Subject ConfigurationBlank subjectThe subject can be left blank when it is not required.
Message FormatPlain textDisplays the message as plain text. Line breaks are preserved and formatting is not applied.
Message FormatMarkdownAllows Markdown formatting such as bold, italic, code, links, and bullet lists.
Message ConfigurationMessageEnter the content that should be sent to the recipient.
Message ConfigurationWorkflow valuesAllows dynamic values from the workflow to be included automatically in the message.
Message ConfigurationPreviewDisplays a preview of the configured notification using sample values.

10. Send Email Configuration

The Send email action allows the workflow to automatically send an email to a specified recipient.

Workflow Send Email

When Send email is selected and the configuration panel is scrolled down, the following fields are available.

Workflow Send Email Configuration

SectionField / OptionDescription
GeneralStep labelDefines the name of the workflow step. The default value is Send email.
RecipientTo*Enter the email address of the recipient. Dynamic workflow tokens can also be used for routing the email to the appropriate person.
EmailSubject*Enter the subject of the email.
Message FormatPlain textSends the email as plain text. Line breaks are preserved without additional formatting.
Message FormatMarkdownAllows Markdown formatting such as bold, italic, code, links, and bullet lists.
Message ContentBodyEnter the main content of the email that will be sent to the recipient.
PreviewPreview (with sample values)Displays a preview of how the email will appear using sample workflow values.
Dynamic ValuesAvailable tokensProvides workflow tokens that can be inserted into the To, Subject, or Body fields.

11. Assign Configuration

The Assign action allows you to automatically assign a user or team to a work order.

This is particularly useful for Work order created triggers, where you want to ensure the work is assigned immediately when the work order is created.

Assign Action in Trigger

When Assign is selected from the Add a step options, the assignment configuration panel is displayed.

Assign Configuration

SectionField / OptionDescription
GeneralStep labelDefines the name of the workflow step. The default value is Assign.
InformationHow this step worksAssigns the selected user or team to the current work order. This step is meaningful for work_order_created triggers or when a Create work order step has run earlier in the workflow.
AssignmentAssign to userSelect the user who should be assigned to the current work order.
AssignmentOr assign to teamSelect the team that should be assigned to the current work order.
Assignment RequirementUser or teamA user, a team, or both can be selected. At least one assignment is required.
ConditionOnly if unassignedRuns the assignment step only when the work order does not already have an assigned user or team.
Condition DescriptionSkip this step if someone is already assigned to the work orderPrevents the workflow from changing an existing assignment when the option is enabled.
ActionAdd stepAdds the configured Assign action to the workflow after the required assignment information is provided.
ActionCancelCloses the configuration panel without adding the step.

12. Update Field Configuration

The Update field action allows the workflow to automatically update a field such as priority, status, or category when the workflow reaches this step.

Update Field Action in Trigger

Update Action in Trigger

SectionField / OptionDescription
InformationUpdate fieldAutomatically updates a field such as priority, status, or category.
GeneralStep labelDefines the name of the workflow step. The default value is Update field.
InformationHow this step worksUpdates a single field on the resource identified by the workflow trigger. If the trigger does not identify a resource, the step does not perform any action.
Field ConfigurationSelect field*Select the field that needs to be updated.
Field ConfigurationValueEnter or select the new value for the selected field.
InformationField restrictionsOnly supported fields can be modified through workflows. Other fields remain unchanged to maintain workflow safety and ensure audit trail, notifications, and other automations continue to work correctly.
ActionAdd stepAdds the configured Update field action to the workflow. The required field and value must be provided.
ActionCancelCloses the configuration panel without adding the step.

13. Create Work Order Configuration

The Create work order action allows the workflow to automatically create a new work order when the workflow reaches this step.

Create Work Order Action in Trigger

Create Work Order Configuration - Schedule and Linked Items

SectionField / OptionDescription
GeneralStep labelDefines the name of the workflow step. The default value is Create work order.
GeneralTitle*Enter the title of the work order that will be created.
GeneralDescriptionEnter the description of the work order.
DescriptionCopy description from source requestCopies the description from the source request into the newly created work order.
DescriptionLink the new WO back to the source requestLinks the newly created work order to the source request when the workflow is triggered by a request.
DescriptionCopy photos from the request onto the new work orderCopies photos attached to the source request to the newly created work order.
PriorityInherit priority from the source requestUses the priority of the source request for the newly created work order.
PriorityPrioritySelect the priority for the new work order, such as Medium Priority.
Work TypeWork TypeSelect the work type for the new work order, such as Reactive.
AssignmentAssign to personSelect the person who should be assigned to the newly created work order.
AssignmentAssign to teamSelect the team that should be assigned to the newly created work order.
ReporterReporterSelect who should be recorded as the reporter of the new work order. Default — the person who triggered the workflow can be used.
Location & AssetInherit the trigger's location when the picker below is emptyUses the trigger's location as a fallback when no specific location is selected.
Location & AssetSiteSelect the site for the new work order. Leave empty to inherit the site from the trigger.
Location & AssetLocationSelect a location after selecting a site. Leave empty to inherit the location from the trigger.
Location & AssetAssetSelect an asset for the new work order. Leave empty to inherit the asset from the trigger where applicable.
ScheduleStart dateSelect the planned start date for the work order.
ScheduleDue dateSelect the planned due date for the work order.
ScheduleEst. hoursEnter the estimated number of hours required to complete the work order.
ScheduleEst. minutesEnter the estimated number of minutes required to complete the work order.
ScheduleCreate immediately when workflow runsCreates the work order immediately when the workflow reaches this step.
Linked ItemsSelect checklistsSelect a checklist to attach to the newly created work order.
Linked ItemsNo vendorSelect a vendor for the work order when required.
Linked ItemsSelect categorySelect the category for the new work order.
Linked ItemsReport template — use org defaultSelect a report template or use the organization's default report template.
AttachmentsUpload filesUpload files that will be attached to the newly created work order.
Available TokensWorkflow tokensAllows workflow values such as title, description, priority, site name, location, asset name, and other supported values to be used dynamically in the work order fields.

14. Create Task Configuration

The Create task action allows the workflow to automatically create a new task when the workflow reaches this step.

Create Task Action in Trigger

Create Task Configuration - General

SectionField / OptionDescription
GeneralStep labelDefines the name of the workflow step. The default value is Create task.
GeneralTitle*Enter the title of the task that will be created.
GeneralDescriptionEnter the description of the task.
DescriptionCopy description from source requestCopies the description from the source request into the newly created task.
DescriptionLink the new task back to the source requestLinks the newly created task to the source request when the workflow is triggered by a request.
DescriptionCopy photos from the request onto the new taskCopies photos attached to the source request to the newly created task.
PriorityInherit priority from the source requestUses the priority of the source request for the newly created task.
PriorityPrioritySelect the priority for the new task, such as Medium Priority.
Work TypeWork TypeSelect the work type for the new task, such as Reactive.
AssignmentAssign to personSelect the person who should be assigned to the newly created task.
AssignmentAssign to teamSelect the team that should be assigned to the newly created task.
ReporterReporterSelect who should be recorded as the reporter of the new task. Default — the person who triggered the workflow can be used.
Location & AssetInherit the trigger's location when the picker below is emptyUses the trigger's location as a fallback when no specific location is selected.
Location & AssetSiteSelect the site for the new task. Leave empty to inherit the site from the trigger.
Location & AssetLocationSelect a location after selecting a site. Leave empty to inherit the location from the trigger.
Location & AssetAssetSelect an asset for the new task. Leave empty to inherit the asset from the trigger where applicable.
ScheduleStart dateSelect the planned start date for the task.
ScheduleDue dateSelect the planned due date for the task.
ScheduleEst. hoursEnter the estimated number of hours required to complete the task.
ScheduleEst. minutesEnter the estimated number of minutes required to complete the task.
ScheduleCreate immediately when workflow runsCreates the task immediately when the workflow reaches this step.
Linked ItemsSelect checklistsSelect a checklist to attach to the newly created task.
Linked ItemsSelect categorySelect the category for the new task.
Linked ItemsReport template — use org defaultSelect a report template or use the organization's default report template.
AttachmentsUpload filesUpload files that will be attached to the newly created task.
Available TokensWorkflow tokensAllows supported workflow values such as title, description, priority, site name, location, asset name, and other available values to be used dynamically in the task fields.

15. Attach Checklist Configuration

The Attach checklist action allows the workflow to automatically attach a checklist template to a work order when the workflow reaches this step.

Attach Checklist Action

When Attach checklist is selected from the Add a step options, the checklist configuration panel is displayed.

Attach Checklist Configuration

SectionField / OptionDescription
InformationAttach checklistAutomatically attaches a checklist template to the work order.
GeneralStep labelDefines the name of the workflow step. The default value is Attach checklist.
ChecklistSelect checklistSelect the checklist template that should be attached to the work order.
ActionAdd stepAdds the configured Attach checklist action to the workflow.
ActionCancelCloses the configuration panel without adding the step.

16. Copy Request Attachments Configuration

The Copy request attachments action allows the workflow to copy attachments from a source request to the current work order.

Copy Request Attachments Configuration

Copy Request Attachments Configuration - Details

SectionField / OptionDescription
GeneralStep labelDefines the name of the workflow step. The default value is Copy request attachments.
InformationTrigger RequirementThis step requires a request and a work order in the workflow context.
ActionCopy attachments from source request → work orderCopies the attachments from the source request to the current work order.
ConfigurationNo configuration neededNo additional fields or settings are required for this action.
UsageCopy request attachmentsCan be used as a standalone workflow step when the work order already exists, or when attachments need to be copied to multiple work orders from the same request.
ActionAdd stepAdds the Copy request attachments action to the workflow.
ActionCancelCloses the configuration panel without adding the step.

Important: This step requires both a request and a work order in the workflow context. If the selected trigger does not provide the required context, the step will not run.


17. Approve / Decline Request Configuration

The Approve / decline request action allows the workflow to mark the source request as either approved or declined. It performs the same service as the corresponding manual buttons and sends the same customer emails.

Approve / Decline Request Configuration

SectionField / OptionDescription
InformationApprove / decline requestMarks the source request as either approved or declined.
GeneralStep labelDefines the name of the workflow step. The default value is Approve / decline request.
Trigger RequirementRequest context requiredThis step requires a request in the workflow context.
Trigger CompatibilityRequest submittedThe action is intended to run meaningfully when the workflow is triggered by Request submitted.
ActionApprove the requestApproves the source request and performs the same service as the manual Approve action, including the associated customer emails.
ActionDecline the requestDeclines the source request and performs the same service as the manual Decline action, including the associated customer emails.
ConfigurationAction dropdownSelect whether the workflow should Approve the request or Decline the request.
ActionAdd stepAdds the configured Approve / decline request action to the workflow.
ActionCancelCloses the configuration panel without adding the step.

Important: The selected trigger must provide a request context. If the workflow is triggered by Work order created, this step will not run because the required request context is not available.


18. Webhook Configuration

The Webhook action allows the workflow to send an HTTP request to an external URL. This can be used to integrate the workflow with external services such as Slack, Microsoft Teams, PagerDuty, Zapier, or other APIs.

Webhook Configuration

Webhook Configuration - Details

SectionField / OptionDescription
InformationWebhookSends an HTTP request to an external URL when the workflow reaches this step.
GeneralStep labelDefines the name of the workflow step. The default value is Webhook.
ConnectionURL*Enter the external endpoint URL that should receive the HTTP request.
RequestMethodSelect the HTTP method used for the request. The available value shown is POST.
SecurityAuthenticationDefines how the request is authenticated. The available value shown is None.
Request DataPayload (JSON)Enter the JSON data that should be sent to the external endpoint.
Request DataVariablesWorkflow variables can be used in the payload where supported.
Error HandlingFail workflow on errorWhen enabled, the workflow stops if the webhook request returns an error.

19. Workflow Steps

After configuring and adding the required workflow steps, the workflow is displayed in sequence under the selected trigger.

Workflow with Added Steps

StepWorkflow StepDescription
TriggerWork order createdStarts the workflow whenever a new work order is created.
1Assign to Housekeeping CrewAssigns the work order to the selected housekeeping team.
2Notify SupervisorSends a notification to the configured supervisor.
3Approve / decline requestApproves or declines the applicable request according to the configured action.
4Send notificationSends the configured notification after the previous workflow steps are completed.
+Add stepAllows additional workflow actions to be added to the sequence.

20. Workflow Actions

The available actions are displayed in the toolbar above the workflow diagram when editing a workflow.

Workflow Actions

ActionDescription
TestAllows you to test the workflow and verify how the configured workflow behaves before enabling it.
ActiveIndicates that the workflow is enabled and will run automatically when its configured trigger occurs.
InactiveIndicates that the workflow is disabled and will not run when the configured trigger occurs.
DuplicateCreates a copy of the current workflow so it can be reused or modified as a separate workflow.
SaveSaves the workflow configuration and any changes made to it.

21. Complete Workflow

The complete workflow explains how a user creates, configures, manages, and activates a workflow.

Open Workflows
      ↓
View Workflows List
      ↓
Search Workflow / Select Status
      ↓
Click New workflow
      ↓
New Workflow Pop-up
      ↓
Enter Workflow Name
      ↓
Enter Description if Required
      ↓
Select Customer Scope
      ↓
Select Workflow Trigger
      ↓
Review Trigger Conditions
      ↓
Click Create & configure
      ↓
Workflow Configuration Page
      ↓
Review Selected Trigger
      ↓
Click +
      ↓
Add a step
      ↓
Select Required Action
      ↓
Configure Action
      ↓
Add Step
      ↓
Review Added Step
      ↓
Click + to Add Another Step
      ↓
Configure Additional Steps
      ↓
Review Complete Workflow
      ↓
Test Workflow
      ↓
Save Workflow
      ↓
Set Workflow Status
      ↓
Active
      ↓
Workflow Runs Automatically
      ↓
Trigger Event Occurs
      ↓
Configured Workflow Steps Execute