Skip to main content
POST
Publish the workflow’s current draft as a new immutable version. New runs created via Run Workflow, schedules, or webhooks always execute against the latest published version — edits to the draft after publish do not affect in-flight or future runs until you publish again. Pass an optional description to record what changed in this version.
Publishing happens inside one environment. A test workflow publishes to the test environment; a production workflow publishes to production.

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string
required

Body

application/json

Optional request body for publishing a workflow.

description
string
default:""

Optional description for this published version

Response

Successful Response

A workflow and its current configuration.

id
string
required

Unique ID for this workflow

created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string
default:Untitled Workflow

The name of the workflow

description
string
default:""

Description of the workflow

project_id
string | null

Project that owns this workflow. Null only on legacy rows that predate the project backfill.

published
WorkflowPublished · object | null

Published workflow metadata when a published version exists