Skip to Content

View Workflow Executions

In this guide, you’ll learn how to view workflow executions in the admin.

Note: This section is primarily for developers and technical teams who are building or debugging custom workflows in their commerce application.


What are Workflow Executions?

A workflow is a sequence of steps that together perform a task — for example, creating an order, syncing data, or handling a fulfillment.
Workflows can be customized in your source code to implement specific business logic or automate processes.

When you execute a workflow, each step runs in sequence.
If you’ve configured your workflows to store their executions in the database (as described in the Store Workflow Executions guide), you can view those executions and inspect their details directly in the admin.

This is useful for debugging workflows and verifying that they run as expected.


View Workflow Executions

To view workflow executions:

  1. Go to Settings → Workflows.
  2. You’ll see a list of all stored workflow executions, including both built-in and custom workflows.
  3. You can search through the list to find specific workflows by name, ID, or status.

Workflow Execution Status

Each workflow execution has a status that reflects its progress or outcome.

StatusDescription
Not StartedThe workflow has been triggered, but none of its steps have started running yet.
InvokingThe workflow is currently running and executing its steps.
DoneThe workflow has completed successfully.
FailedThe workflow encountered an error and failed.
CompensatingThe workflow is compensating (rolling back) its steps after a failure.
RevertedThe workflow has been reverted, typically when it runs as part of another workflow that fails.

View Workflow Execution Details

To view detailed information about a specific workflow execution:

  1. Go to Settings → Workflows.
  2. Click on the workflow execution you want to inspect.
  3. You’ll be taken to the Workflow Execution Details page, which includes several sections.

Summary Section

The Summary section provides a high-level overview of the workflow execution, including:

  • A status badge showing the current execution state.
  • The workflow ID — the unique identifier you define in code.
  • The transaction ID — a unique ID for this specific execution, useful for debugging or tracking long-running workflows.
  • The progress indicator, which gives a quick visual overview of which steps have been executed.

Timeline

The Timeline diagram visualizes the workflow’s step-by-step execution.

  • You can zoom in/out and drag to navigate the diagram.
  • Clicking on a step node opens its execution details in the History section.

Step Status Colors

Each step node displays a small colored box that indicates its execution status:

ColorMeaning
🟠 OrangeThe step is currently being executed.
🟢 GreenThe step has completed successfully.
🔴 RedThe step has failed.
GrayThe step hasn’t run yet or was skipped (for example, when part of a conditional step).

JSON

The JSON section allows you to view all execution details as raw JSON data.
Click the icon to toggle this view.
This is particularly helpful for advanced debugging to inspect workflow variables and state at a low level.


History

The History section lists all executed steps in order.
Each step entry shows:

  • The step name, with a status dot that reflects its state (as shown in the Step Status table above).
  • When you click a step, you can view detailed information including:
    • Definition: Configuration of the step (e.g., name, async flag, compensation settings).
    • Output: The result produced by the step after execution.
    • Compensation Input: The data passed to the step’s compensation function (if applicable).
    • Error: Any error message if the step failed.

That’s it — you now know how to explore and debug workflow executions directly in the admin.

Last updated on