Overview
Workflows are a set of activities that are executed in a specific order. Workflows can be triggered by events or manually. Workflows can be used to automate business processes and integrate with external systems.
Workflow Document Type
A Document Type workflow is a special workflow type that defines the process for generating a document such as a PDF, Excel, or CSV. It can be used to generate various document types, such as invoices, purchase orders, and more.
Workflow EmailTemplate Type
Introduction
Workflow Rate Quote Type
A Workflow Rate Quote Type is a special workflow type that defines the process for generating a rate quote.
Workflow Rule Tariff Type
Workflow Rule Tariff Type is a workflow type that defines a rule to calculate additional charges based on the tariff.
Workflow YAML
Workflows are a set of activities that are executed in a specific order. Workflows can be triggered by events or manually. Workflows can be used to automate business processes and integrate with external systems
Workflow Tasks
33 items
Triggers
Triggers are the starting point of any workflow. They define when and how a workflow should be executed. This document covers the different types of triggers available in our system and how to configure them using YAML.
Workflow Webhook
Workflow Webhook is a workflow type that defines processes triggered by webhooks. It allows external systems to trigger workflows via HTTP requests.
Workflow Audit
Workflow Audit provides execution history tracking for workflows, allowing you to monitor workflow runs, view execution logs, and troubleshoot failed executions.
Workflow Flow Type
Introduction
Activities
Activities define the actions that should be taken when certain conditions are met within a workflow. They are executed in the order they are defined.
Workflow Public API
A Public API workflow exposes custom REST endpoints that external systems, partners, or frontend applications can call. Each workflow defines a single HTTP endpoint with its own path, method, authentication, rate limiting, and business logic.
Variables
Workflow variables store and pass data between tasks. They can be defined in the variables section of a workflow or task, and assigned in inputs, variables, and outputs sections.
Expressions
Expressions are used to evaluate conditions, map data, and more.
Examples
2 items
Examples of Workflows
Notify Parcel Shipped
Document Templates
Table of Contents
Workflow Validation Errors
This page documents all validation error codes that can occur when creating or updating a workflow. Each error includes a description, common causes, and how to fix it.