Tools reference/Workflows

Workflows tools.

Workflows are named steps that run the same way every time. Your assistant can list them, read one, save a draft for a person to turn on, start a run where you're allowed to, and see what a run did. It never turns a workflow on by itself.

The live list

Your AI tool can call searchTools with category: "workflows" for the current list of these tools with every input. This page is the readable copy.

The tools

Every tool below keeps to the access of the key or sign-in that calls it, and to the person’s own role. A tool only sees the tools it may use.

  • getWorkflow

    Read one workflow, one of its runs, or the guide to writing one.

  • listWorkflows

    List the organisation's workflows: named steps that run the same way every time, such as sending a reminder each morning or making an invoice when a deal is won.

  • runWorkflow

    Start a run of a workflow that is on, as its Run button does, or as its button on one row does (row).

  • saveWorkflowDraft

    Save a workflow's whole tree as its draft: a new workflow (leave out workflowId) or an existing one (workflowId with the baseHash getWorkflow gave).