Skip to Content
Welcome to 10ex Docs — explore Tutorials, Guides, Reference, Concepts, Use Cases, and the Agent Store.
ReferenceREST APIflows
Reference

flows

Base path: /api/v1/flows

The flows module is the orchestration surface. You list and create workflows, browse templates, manually trigger a run, and manage ExternalTrigger rows that fire flows on CRM or connector events. A flow is a directed graph of steps where each step is an agent call, a connector action, a wait, or a branch. Resources include workflows, workflow versions, runs, steps, triggers, and templates. Schemas live in app/modules/flows/schemas.py.

What you can do with the flows API

  • List and inspect existing workflows in your workspace
  • Instantiate a workflow from a template
  • Trigger a workflow manually with a typed input payload
  • Configure an ExternalTrigger to fire on a CRM or connector event
  • Pause, resume, or cancel a running flow
  • Inspect the per-step trace of a completed run

Common operations

  • Browse the template gallery and create a workflow from one
  • Update a workflow’s graph (steps, edges, branch conditions)
  • Trigger a manual run and stream its progress
  • Add an ExternalTrigger so a lead.created event auto-runs a flow
  • List recent runs filtered by workflow, status, or trigger source
  • Archive an old workflow version while keeping its run history

Authentication & scoping

Workspace-scoped via API key in the Authorization: Bearer tnx_... header. Workflows, triggers, and runs are isolated per workspace.

Pagination & filtering

Run and template list endpoints paginate cursor-style with filters by status, trigger type, and date range. See Pagination.

What you can do with the flows API for event-driven automation

The most common pattern is lead enters segment X -> enrich the lead -> add to email sequence Y. You define this once as a flow with an ExternalTrigger listening for the segment-membership event, and it runs forever without you touching it again.

MCP equivalents

MCP prompt

list_workflow_templates()

MCP prompt

create_workflow_from_template({ template_slug: "lead-to-sequence", inputs: { ... } })

MCP prompt

trigger_workflow({ workflow_id, payload: { lead_id } })

  • Concepts: Flows for the runtime model
  • crm for the events that drive most triggers
  • agents for the agents that fill flow steps
  • Webhooks for receiving flow lifecycle events
Last updated on
marketingknowledge