Skip to navigation
WorkflowsAuthoring

Flows · Authoring · Create an empty draft workflow

View as Markdown

Creates a workflow with no steps in it. Returns {id, slug, status, …} with status of DRAFT.

A draft cannot be run: it has no step graph and has never been published.

A slug is generated from the title when omitted, with a random suffix for uniqueness. Pass one only if you need a specific value.

Read resource: workflow://diagram-grammar before building. It carries the full authoring lifecycle and the step-graph grammar, neither of which is guessable from these schemas.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
titlestringRequired

Human-readable name, shown in the workflow list.

descriptionstringOptional
Optional longer explanation of what it does.
slugstringOptional

Optional. Generated from title when omitted, which is almost always what you want.

Response

Draft created. id is the workflow-definition ID.

Errors

400
Bad Request Error
429
Too Many Requests Error