Skip to main content

​
Overview

Publishing makes your workflow available for task creation. Until published, workflows remain in draft mode and cannot be used.

Version Control

Each publish creates a new version

Instant Deploy

Changes go live immediately

Draft Mode

Test changes before publishing

Rollback

Revert to previous versions if needed

​
Workflow States

StateDescription
DraftWork in progress, not available to users
PublishedLive and available for task creation
ArchivedNo longer active, historical reference

​
Publishing Your Workflow

1

Complete Design

Ensure your workflow has:
  • At least one initial step (e.g., NEW)
  • At least one terminal step (e.g., COMPLETED)
  • All screens configured with components
  • Transitions connecting all nodes
2

Test Your Workflow

Use Test Mode to verify everything works
3

Click Publish

Click the Publish button in the top toolbar
4

Confirm

Review the publish summary and confirm
Publishing creates a new version. Existing tasks continue on their current version; new tasks use the latest published version.

​
Pre-Publish Checklist

Before publishing, verify:
  • Initial step exists and is properly configured
  • Terminal steps exist for all end states
  • All nodes are connected with transitions
  • No orphan nodes (disconnected from flow)
  • All screen nodes have components
  • Required data fields are bound to input components
  • Transition buttons have descriptive names
  • On-load automations are configured if needed
  • All required data fields are defined
  • Create-time fields are properly configured
  • Data types match component types
  • Transition automations are tested
  • API endpoints are accessible
  • Error handling is in place

​
Version Management

Each publish creates a new version: 
Version 1 (Published Jan 1)
    ↓
Version 2 (Published Jan 15) ← Current
    ↓
Version 3 (Draft)

​
How Versions Work

  • New tasks: Always use the latest published version
  • Existing tasks: Continue on the version they started with
  • Draft changes: Don’t affect existing tasks until published

​
After Publishing

Once published, you can:
  1. Create Tasks: Assign tasks to users from this workflow
  2. Monitor Execution: Track task progress and completion
  3. Make Changes: Edit and publish new versions
  4. View Analytics: See workflow performance metrics

​
Unpublishing / Archiving

To remove a workflow from active use:
1

Open Workflow Settings

Click the settings icon in the workflow builder
2

Archive Workflow

Select Archive Workflow
3

Confirm

Existing tasks will continue, but no new tasks can be created

​
For AI Agents

​
Workflow Status

interface WorkflowVersion {
  workflowId: string;
  version: number;
  status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
  publishedAt?: string;
  publishedBy?: string;
}

​
API: Publish Workflow

POST /api/v1/workflows/:workflowId/publish
Authorization: Bearer {token}
Response: 
{
  "workflowId": "wf_abc123",
  "version": 3,
  "status": "PUBLISHED",
  "publishedAt": "2024-01-15T10:30:00Z"
}

​
API: Get Workflow Versions

GET /api/v1/workflows/:workflowId/versions
Authorization: Bearer {token}

​
API: Archive Workflow

POST /api/v1/workflows/:workflowId/archive
Authorization: Bearer {token}

​
UI Components

ComponentLocationPurpose
PublishButton/src/views/workflows/toolbar/Publish action
PublishDialog/src/views/workflows/publish/Confirmation dialog
VersionHistory/src/views/workflows/versions/Version listing

​
Event Tracking

// Publishing events
WorkflowEvents.WORKFLOW_PUBLISHED
WorkflowEvents.WORKFLOW_ARCHIVED
WorkflowEvents.VERSION_CREATED

​
Validation Rules

Before publishing, the system validates: 
interface PublishValidation {
  hasInitialNode: boolean;
  hasTerminalNode: boolean;
  allNodesConnected: boolean;
  noOrphanNodes: boolean;
  allScreensConfigured: boolean;
  dataFieldsValid: boolean;
}
Publishing fails if any validation returns false.