Skip to navigation
WorkflowsAuthoring

Flows · Authoring · Compile the diagram and make the workflow runnable

View as Markdown

Compiles the workflow’s stored diagram into its executable graph, sets the workflow ACTIVE, and increments its version. Returns {"version": N}.

A workflow cannot run until this is called, and edits made after the last publish are not used by new runs.

Validation happens here rather than on save. A malformed diagram returns 400 naming the offending block — read that message rather than retrying blindly.

Omit version to publish the next one, which is the normal case. Passing an explicit version overwrites that version and discards its history.

resource: workflow://diagram-grammar lists the usual causes of a 400 here.

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.

Path parameters

workflow_idintegerRequired

Numeric workflow-definition ID. Not a run ID.

Request

This endpoint expects an object.
commentstringOptional<=255 characters
Note stored against this version.
versionintegerOptional
Overwrite a specific version instead of publishing the next one. Discards that version's history. Omit normally.

Response

Published. Body is {"version": N}.

Errors

400
Bad Request Error
404
Not Found Error