Use the Deployments block to manage other workflows in the current workspace. Deploy creates a new version; Promote Version to Live makes an existing version live without creating another. Undeploy takes a workflow offline and removes its triggers, webhooks, and schedules.
For the deployment UI and execution model, see Workflow Deployment.
Use the block
Deploy, undeploy, and roll back workflows in the current workspace. Promote a previous deployment version to live, list every version, or fetch the deployed workflow state for a specific version.
Actions
Deploy Workflow
Deploy a workflow’s current draft state, creating a new deployment version and making it live for API execution. Requires admin permission on the workflow’s workspace.
Input
Output
| Parameter | Type | Description |
|---|---|---|
workflowId | string | ID of the deployed workflow |
isDeployed | boolean | Whether the workflow is now deployed |
deployedAt | string | ISO 8601 timestamp of the deployment (null if unavailable) |
version | number | The deployment version that is now active |
warnings | array | Non-fatal warnings (e.g. trigger or schedule sync still in progress) |
Undeploy Workflow
Take a deployed workflow offline. API execution stops and schedules, webhooks, and other deployment side effects are removed. Requires admin permission on the workflow’s workspace.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | ID of the workflow to undeploy |
Output
| Parameter | Type | Description |
|---|---|---|
workflowId | string | ID of the undeployed workflow |
isDeployed | boolean | Whether the workflow is still deployed (false) |
deployedAt | string | Always null after an undeploy |
warnings | array | Non-fatal warnings (e.g. trigger or schedule cleanup still in progress) |
Promote Version to Live
Make a specific deployment version the live one without creating a new version — the same operation as Promote to live in the deploy modal. Useful for rolling back to a known-good version. Also works on an undeployed workflow: it re-deploys the workflow live at that version. Requires admin permission on the workflow’s workspace.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | ID of the workflow |
version | number | Yes | The deployment version number to promote to live |
Output
| Parameter | Type | Description |
|---|---|---|
workflowId | string | ID of the workflow |
isDeployed | boolean | Whether the workflow is now deployed |
deployedAt | string | ISO 8601 timestamp of the active deployment (null if unavailable) |
version | number | The deployment version that is now live |
warnings | array | Non-fatal warnings (e.g. trigger or schedule sync still in progress) |
List Deployment Versions
List every deployment version of a workflow, newest first, including which version is currently live.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | ID of the workflow |
Output
| Parameter | Type | Description |
|---|---|---|
workflowId | string | ID of the workflow |
versions | array | Deployment versions, newest first (id, version, name, description, isActive, createdAt, createdBy, deployedByName) |
Get Deployment Version
Fetch a single deployment version of a workflow, including its metadata and the full workflow state snapshot that was deployed.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | ID of the workflow |
version | number | Yes | The deployment version number to fetch |