F
Flowman docsWorkflow SDK
Back to app

Flowman documentation

Flowman now treats the Coding Agent as the primary workflow. The workflow is written with the Vercel Workflow SDK and exposed through a Next.js route handler. The Flowman UI keeps coding-agent workflow metadata — name, slug, description, parameters, and the route that triggers them.

How it fits together

  • Workflow code lives in src/workflows/coding-agent.ts using the "use workflow" and "use step" directives.
  • The route handler at app/api/workflows/coding-agent/route.ts calls start() from workflow/api to invoke the workflow.
  • A registry entry in Flowman links a slug + route to the UI. New workflows are coding-agent-derived templates with preconfigured fields and defaults.
  • Project environment variables (docs): configure per customer under Environment variables in the project sidebar. They are snapshotted into record.env when a run starts — not from tenant .env files.
  • Shared step actions (reference): reusable actions such as approval gates with live Convex rows + Workflow createWebhook().
  • Connectors (docs): long-running infrastructure integrations that ingest external data, store normalized records, and emit platform events.
  • Triggers and events (docs): project-scoped routing rules evaluate normalized events and dispatch matching workflow runs through the canonical workflow route.
  • Zrok setup (docs): expose local Flowman to Convex cloud for trigger dispatch during development.
  • Triggering a run from the UI POSTs to the route, persists a run row, and lands you on the run detail page.

Explore the docs

Jump into the route, runtime, and integration details that make up a coding-agent workflow.