Skip to Content

next-workflow-builder

DevKit AI Builder Template DocumentationMarketplace
CTRL K
Demo
CTRL K
  • DevKit 
  • AI Builder Template 
    • Introduction
    • Getting Started
    • Configuration
    • Plugins
      • Overview
      • HTTP Request
      • Condition
      • Loop
      • Merge
      • Database Query
      • Run Workflow
      • Run Workflows in Sequence
      • Switch
    • Creating Plugins
    • API Reference
    • CLI Reference
    • Dashboard
    • Components
    • Database
    • Authentication
    • Deployment
    • Architecture
    • Contributing
    • MCP Server
  • Marketplace
  • Introduction
  • Getting Started
  • Configuration
  • Plugins
    • Overview
    • HTTP Request
    • Condition
    • Loop
    • Merge
    • Database Query
    • Run Workflow
    • Run Workflows in Sequence
    • Switch
  • Creating Plugins
  • API Reference
  • CLI Reference
  • Dashboard
  • Components
  • Database
  • Authentication
  • Deployment
  • Architecture
  • Contributing
  • MCP Server

On This Page

  • Features
  • Accessing the Dashboard
  • Using the exported component
  • Table columns
  • Action buttons
  • Status badges
  • API endpoint
Question? Give us feedback Edit this page 
DocumentationDashboard

Dashboard

The Dashboard page provides a workflow-centric overview with aggregated execution stats per workflow. It is available at /dashboard.

Features

  • Summary stats — total workflows, total runs, success count, and error count at a glance
  • Workflow table — each row shows workflow name, run counts (total, success, error, stopped), latest run status badge with relative time, and action buttons
  • Inline actions — execute, stop, and delete workflows directly from the dashboard
  • Live updates — polls every 5 seconds so running workflows update automatically
  • Quick navigation — click a workflow name to jump to its editor

Accessing the Dashboard

The dashboard is accessible in two ways:

  1. User menu — click your avatar in the top-right corner and select Dashboard
  2. Direct URL — navigate to /dashboard

Using the exported component

If you use a custom routing setup instead of the built-in WorkflowPage catch-all, you can import DashboardPage directly:

import { DashboardPage } from "next-workflow-builder/client"; export default function MyDashboardRoute() { return <DashboardPage />; }

Table columns

ColumnDescription
WorkflowName (links to editor) and description
RunsTotal execution count
SuccessCount of successful executions (green)
ErrorCount of failed executions (red)
StoppedCount of cancelled executions (gray)
Latest RunStatus badge and relative time of most recent execution
ActionsPlay (execute), Stop (cancel running), Delete

Action buttons

ButtonConditionDescription
PlayNo running executionStarts a new execution of the workflow
StopHas a running/pending executionCancels the currently running execution
DeleteAlways visibleDeletes the workflow and all its executions (with confirmation)

Status badges

StatusColorDescription
SuccessGreenWorkflow completed without errors
ErrorRedWorkflow failed during execution
RunningBlue (animated)Workflow is currently executing
PendingYellowWorkflow is queued but not yet started
CancelledGrayWorkflow was manually stopped

API endpoint

The dashboard fetches data from:

GET /api/workflows/dashboard

Returns all workflows for the authenticated user with aggregated execution stats. Each entry includes:

FieldTypeDescription
idstringWorkflow ID
namestringWorkflow name
descriptionstring | nullWorkflow description
updatedAtstringISO 8601 timestamp
totalRunsnumberTotal execution count
successCountnumberExecutions with status "success"
errorCountnumberExecutions with status "error"
cancelledCountnumberExecutions with status "cancelled"
latestRunStatusstring | nullStatus of the most recent execution
latestRunStartedAtstring | nullISO 8601 timestamp of the most recent execution
runningExecutionIdstring | nullID of currently running/pending execution (for stop button)
Last updated on March 16, 2026
CLI ReferenceComponents

© 2026 All rights reserved.

Product by David Sanchez