Skip to main content

​
About

Every workflow in Interactly is version-controlled from the moment it is created. Version 0 is generated automatically on creation and serves as your working baseline. As your workflow evolves, you can snapshot the current state into a new named version, activate it for live execution, and roll back instantly if something goes wrong — all without disrupting runs already in progress.
In-flight workflow runs always complete on the version they started with. Activating a new version only affects executions that begin after the activation.

​
How Versioning Works

Version 0 — Working Draft

Created automatically when you first create a workflow. This is your editable baseline. All changes made in the builder apply here until you snapshot a new version.

Named Versions — Snapshots

Each new version is an immutable snapshot of your workflow’s nodes, edges, and configuration at a point in time. Snapshots can be named, activated, compared, exported, and restored.

Active Version — Live Execution

Only one version is active at a time. All workflow executions — triggered manually, via schedule, or via webhook — run on the active version by default unless a specific version is requested.

Independent Editing

Each version can be edited independently. You can refine a future version while the current active version continues serving live traffic.

​
Creating a New Version

1

Open Version Management

Navigate to your workflow in the dashboard and click the Versions panel or the version indicator at the top of the builder.

Version management panel

2

Create a Snapshot

Click New Version. You will be prompted to:
  • Give the version a meaningful name — e.g. "v1 — Initial Release" or "v2 — Add Callback Branch"
  • Optionally check Mark new version as active to immediately make this version live upon creation
Use descriptive version names that reflect what changed — this makes it easy to identify the right version when reviewing history or rolling back.
3

Edit the New Version

After creation, select the new version in the builder. All edits — adding nodes, changing edge conditions, updating prompts — apply only to this version until you activate it.
4

Mark as Active When Ready

Once you are satisfied with the new version, click Mark as Active. All subsequent executions will use this version. Running executions are not affected.

Activating a version

​
Viewing Version History

Navigate to the Versions panel on any workflow to see its full version history. For each version you can see:
  • Version number and name
  • Created date and author
  • Whether it is the currently active version
Select any two versions and click Compare to see a side-by-side diff of their configurations — nodes added or removed, edge conditions changed, prompt updates, and setting differences.This is useful before activating a new version to verify exactly what will change in live execution.
Select any version from the history list and open it in the builder. Changes are isolated to that version and do not affect other versions or the currently active one.
Editing an older version does not automatically make it active. You must explicitly activate it to route live traffic to it.

​
Import & Export

Workflow versions can be exported as a portable bundle and imported into the same or a different environment — useful for promoting workflows from a staging workspace to production, or for backing up configurations.

Export

Export one or more versions of a workflow as a bundle. You can choose to include specific version numbers or export all versions at once.

Import

Import a previously exported bundle to restore a workflow or bring it into a new environment. The imported workflow retains its version history from the bundle.
Imported workflows are created as new workflows in the target environment. They do not overwrite existing workflows with the same name.

​
Rolling Back

If a newly activated version causes unexpected behaviour, rolling back is straightforward:
1

Open Version History

Go to the Versions panel on the affected workflow.
2

Select the Previous Version

Identify the version that was working correctly before the change.
3

Mark as Active

Click Mark as Active on the previous version. Live traffic is immediately routed back to it.
Runs that started on the problematic version will continue to completion on that version. Only new executions are affected by the rollback.

​
Best Practices

Use version names that describe the change, not just a number. "v3 — Fix callback routing condition" is far more useful than "Version 3" when scanning history under pressure.
Use the Simulation feature to validate a new version interactively before activating it for live traffic.
Avoid overwriting the last known-good version. Create a new snapshot for every meaningful change so you always have a rollback target.
Export a validated version from your staging workflow and import it to production rather than rebuilding manually. This eliminates configuration drift between environments.

​
API Reference

List Versions

GET /workflows/:id/versions Retrieve the full version history for a workflow

Create Version

POST /workflows/:id/versions Snapshot the current configuration as a new named version

Activate Version

POST /workflows/:id/versions/:version/activate Set a version as active for all subsequent executions

Compare Versions

GET /workflows/:id/versions/:version/diff/:version2 Compare two versions of a workflow side by side

Export Workflow

POST /workflows/:id/export Export one or more versions as a portable bundle

Import Workflow

POST /workflows/import/bundle Import a previously exported workflow bundle

​
Next Steps

Simulation

Test a new version interactively before activating it for live traffic

Building a Workflow

Go back to the workflow builder guide

Scheduled Workflows

Set up scheduled and event-driven workflow triggers

Workflow Webhooks

Subscribe to lifecycle events including version activation