Skip to main content
Use versioning to save stable checkpoints of a workflow and use deployments when you want to call that workflow outside the editor. The workflow editor keeps these actions separate so you can keep iterating in the dashboard without changing a live workflow deployment until you are ready.

Overview

The current workflow editor exposes versioning, run, and deployment actions in the bottom control bar. You can use Save Version to record a named checkpoint, Version History to compare versions and roll back, Run Workflow to test in the editor, Logs to open run history, Add Step to append a step before End, and Deploy to create or update workflow deployments and variants. In docs prose, refer to the public runtime surface as a workflow deployment. Keep the actual UI labels such as Create a Deployment and Update a deployment variant exactly as they appear in the product.

How do I save a workflow version?

Open the workflow in the editor. Click Save Version in the bottom control bar. Enter a short description of what changed. Click Save to create a named checkpoint for the current state of the workflow. The current modal requires a description, so write something your team can understand later when you review changes or compare versions.

How do I compare versions and roll back?

Open the workflow in the editor. Click Version History in the bottom control bar. Use the compare selector to choose an older version against the current live version. Review the saved description, author, timestamp, and JSON diff before you make a rollback decision. Click Rollback if you want to restore an earlier version. Then confirm the rollback in the confirmation dialog. Rollback creates a new live version based on the selected version and keeps the current live version in history. To discard unsaved edits instead, click Reset in Version History. Reset restores the workflow to how it was last saved as the current version. It does not create or delete any versions.

How do I create a workflow deployment?

Open the workflow in the editor. Click Deploy in the bottom control bar. Choose Create a Deployment. Enter a Deployment key and click Save. Use lowercase letters, numbers and single dashes, like lead-research (up to 60 characters). You use this key as the deployment value when you call the API. Fetch Hive saves a snapshot of the current workflow and creates the workflow deployment. If Go to deployment page after saving stays enabled, the UI takes you to the deployment page for the new deployment and its initial variant.

How do I add or update a deployment variant?

Open the workflow in the editor. Click Deploy in the bottom control bar. Choose Add a variant to a deployment if you want to create a new named variant from the current workflow state. Choose Update a deployment variant if you want to snapshot the current workflow state into an existing variant. In both flows, select the deployment first. When you add a variant, enter a Variant name. When you update a variant, select the existing variant you want to replace. Enter a description before you save.

What do I see on the deployments page?

Open Deployments from the workflows section in the sidebar. The main table identifies each workflow deployment by Deployment Key and also shows Total Requests, Avg Duration, Total Cost, and collaborators for that deployment. Open a deployment row when you want to inspect a specific deployment and variant in more detail.

How do I schedule a workflow deployment?

Open a workflow deployment from the deployments page. Click Schedules in the deployment header. Create a schedule, choose the deployment variant to run, set the recurrence and timezone, optionally add a callback URL, and provide the required Start input values. Schedules run the published deployment variant with the saved inputs. Scheduled runs appear in workflow logs and include metadata identifying the schedule that launched them. For more detail, see Scheduled Deployments.

Workflow versioning and deployment notes

A workflow version and a workflow deployment variant are related, but they are not the same thing. A workflow version is an editor checkpoint. A deployment variant is part of the runtime surface you use when you invoke the workflow outside the editor. Keep using Run Workflow while you are iterating in the editor. Save a version when you want a named checkpoint, and create or update a workflow deployment when you need a runtime target for your app. See also: Testing and Iteration, Scheduled Deployments, Run with API, and Logs