virtual-steps

Virtual Steps Guide

Virtual Steps are useful for creating a smooth flow in Workbench.

They offer two ways to connect nodes virtually:

• NOOP Steps: Used mostly when we want to override the workflow to add buttons or show UI elements.
• Virtual Connections between steps: Used when we want to connect virtually two steps, with or without NOOP Steps.

Creating NOOP Steps

Steps need to be created in the steps folder, it can be in subfolders.

• Steps in TS and JS should end with .step.ts and .step.js respectively.
• Steps in Python should end with _step.py.

Configuration

TypeScript Example

import { NoopConfig } from 'motia'

export const config: NoopConfig = {
  /**
   * Should always be noop
   */
  type: 'noop',

  /**
   * A unique name for this noop step, used internally and for linking handlers.
   */
  name: 'manual-trigger',

  /**
   * A description for this noop step, used for documentation and UI.
   */
  description: 'Manual trigger point for workflow',

  /**
   * An array of topics this step can emit events to.
   */
  virtualEmits: ['workflow.start'],

  /**
   * An array of topics this step can subscribe to.
   */
  virtualSubscribes: ['manual.trigger'],

  /**
   * An array of flow names this step belongs to.
   */
  flows: ['my-workflow']
}

// NOOP steps don't need handlers - they're purely for Workbench workflow connections

Python Example

config = {
    "type": "noop",
    "name": "manual-trigger",
    "description": "Manual trigger point for workflow",
    "virtualEmits": ["workflow.start"],
    "virtualSubscribes": ["manual.trigger"],
    "flows": ["my-workflow"]
}

# NOOP steps don't need handlers - they're purely for Workbench workflow connections

Common Use Cases

Workflow Starter

This NOOP step will create a flow node in Workbench, then as a UI Step, we will override it to show a button.

TypeScript:

export const config: NoopConfig = {
  type: 'noop',
  name: 'flow-starter',
  description: 'Start point for the workflow',
  virtualEmits: ['process.begin'],
  virtualSubscribes: [],
  flows: ['main-flow']
}