Skip to content

manage_workflows

manage_workflows works with your tenant’s saved workflows. The action parameter selects the operation: list, get, callable, pause, or archive.

Newest first, paged with next_cursor. Each row carries id, name, status (draft, active, paused, archived), its triggers (what starts it — a workflow may have several, each with its schedule in words where it fires on a clock), who created it, the soonest next run, the last run’s outcome, version, and valid. Pass mine: true for just the signed-in user’s workflows.

Show these as a table: name, status, triggers and schedules, last run, next run (and the author, when listing everyone’s).

get — one workflow, as a person reads it

Section titled “get — one workflow, as a person reads it”

Returns the workflow’s steps, each with its label, its block’s display name, and its settings in words — each by its title, each value as a person reads it (an earlier step’s field as that step’s name plus the field’s label, a value picked from a list by that list’s label, a CRM write’s choice in words). Also returns version, status, triggers, the last validation, the five most recent runs, and an open_link — show it exactly as given, never the bare address.

To edit a workflow, pass editable: true: the answer adds editable_steps (the form build_workflow and save_workflow take) and the version to pass as save_workflow’s expected_version. A workflow drawn in a shape the step form can’t represent returns not_editable instead — tell the user it’s edited in OnFire workflows, with its open_link.

callable — workflows external systems can call

Section titled “callable — workflows external systems can call”

Lists the workflows that have a webhook trigger, each with its callable steps: where the rows sit in a call’s body, and each field’s name, type, whether it’s required, and (when the workflow says so) what kind of value it is. Use it when the user asks which of their workflows their systems, a form, Zapier, or an agent can start, or what a call must send.

To run one for the user, call run_workflow start with trigger set to the step and input_items holding the rows. A calling system needs the workflow’s address and one of the tenant’s API keys — both live in OnFire workflows. Never ask for, show, or create a key.

  • pause — an active workflow’s schedule and webhook stop until a person reactivates it in OnFire workflows. It can still be run by hand.
  • archive — the workflow stops for good and can no longer be run. Only archive a workflow the user asked you to remove, or one you created in this conversation and no longer need.

Activating a workflow is not a tool — a person does it in OnFire workflows.

ParameterTypeRequiredDescription
actionstringYeslist, get, callable, pause, or archive.
workflow_idstringEvery action but list / callableThe workflow to act on.
statusstringNoWith list: only workflows in this status.
minebooleanNoWith list: only the signed-in user’s workflows.
editablebooleanNoWith get: also return editable_steps to change and save it.
limitintegerNoWith list (1–100) or callable (1–50): how many (default 20).
cursorstringNoWith list: the previous page’s next_cursor.
target_tenant_idstringNoSuper-tenant administrators only.
  • Speak to the user in display names and labels — a step’s name and block, a side by its label, settings and fields in words. Block types, step ids, and port names are for tool calls only.