Create Workflow

Create an empty workflow. It starts disabled: add its triggers and steps with Add Workflow Trigger and Add Workflow Step (or in the app), publish it, then enable it with Update a Workflow.

POST

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Body

Arguments

stringrequired

The name your team will see in the app.

array of string

Tag ids to put on the workflow, from the workflow tag catalog.

Default: []

string

workflow, or function for one other workflows call.

workflow (the default), or function: a workflow other workflows call with Run Workflow.

Default: workflow

workflow
function

Response fields

idstring

Unique id of the workflow.

namestring

The name your team gave the workflow.

typestring

The workflow's type.

isActiveboolean

True while the workflow is enabled and able to run.

isTemplateboolean

True if this is a template rather than a live workflow.

sizestring

The workflow's runner size: xs, sm, md, lg, xl, or xxl. Empty when sized automatically.

tagsarray of string

Ids of the tags on the workflow. The tag catalog is managed in the app.

createdOndate

When the workflow was created.

createdBystring

Who created it.

updatedOndate

When it was last changed.

updatedBystring

Who last changed it.