To run a workflow, see Workflows Overview.
Workflow definition
Adefinition is a graph of blocks connected by edges:
blocks: each block has ablock_idyou choose, ablock_nameand aspecsobject. See Workflow Blocks, or list them withGET /v1/workflows/blocks.edges: each edge has afrom_block_idand ato_block_id.
Limits
A save over a limit stores nothing.
Create a workflow
Sixtyfour validates the definition before saving. An invalid definition is rejected with422 and nothing is stored. With an OAuth access token, an invalid definition is saved as a draft, which never runs.
workflow_id and revision.
HTTP 201
block_id that is not a UUID is replaced with a new UUID on save, and the edges are rewritten to match.
List workflows
GET /v1/workflows returns your organization’s workflows without their definitions. Results are paginated: pass next_cursor as cursor to read the next page, and set page_size to change the page length.
cURL
Get a workflow
Returns one workflow with its fulldefinition.
Update a workflow
Send only the fields to change:name, description, definition or locked. Include the revision from your last read when you change name, description or definition. If the workflow changed since that read, the update is refused with 409 and nothing is saved.
revision.
Runs that already started keep the definition they started with. An update takes effect from the next run.
Delete a workflow
HTTP 200
Templates
Templates are ready-made workflow definitions. Each template carries its fullblocks and edges, so you can pass them as the definition when you create a workflow.
GET /v1/templates accepts these optional query parameters:
cURL
template_id, scope (global for the catalog, org for your organization’s templates), name, description, category, tags, blocks and edges. Template requests are rate limited. See Rate limits.
Errors
For error responses, see Handling Errors.Pricing
Managing workflows is free. See Credit Costs for more information.Integrations built on
/workflows/create_workflow and the other original routes keep working. Legacy maps each one to its /v1 replacement.