Skip to main content

Deploy a workflow

This guide explains how to deploy your workflows in the different environments. Deployment immediately activates a workflow on the chosen environment: a few clicks are enough, with no complex intermediate steps.

Before you start​

  • The associated trigger must be deployed on the target environment (same environment as the one chosen for the workflow) — without a trigger present on this environment, the workflow cannot be deployed there.
  • The destination environment must exist.
  • You must have the necessary permissions to deploy in this environment.
Simplicity and immediate effect
  • Short path: environment choice, on-screen prerequisites check, validation.
  • Instant effect once the deployment is confirmed (executions driven by the trigger on this environment).
Checks before deployment

Make sure that:

  • The workflow has been tested in a development environment
  • All dictionary variables are configured for the target environment
  • The associated trigger is deployed on the selected environment (prerequisite for the workflow deployment)
  • You have the necessary permissions to deploy in this environment

Deploy a workflow​

Workflow version: you choose the version to deploy according to the environment. The Main version can be used on non-production environments (development, staging, etc.); it cannot be deployed to production — for prod, use a numbered version (SemVer). See Version management.

When deploying a workflow, it is possible to see at a glance:

  • The deployment capabilities
  • The already deployed versions

The interface will then allow you to view the dictionary variables used in the workflow, to:

  • Check the values
  • Validate the presence or not of these variables for the deployment environment
  1. Go to the workflow detail page
  2. Click Deployments
  3. Select the destination environment
  4. Select the version to deploy (if several versions)
  5. Check the dictionary variables
  6. Click Deploy
Recommended order
  1. Trigger: deploy the trigger on the targeted environment (dev, staging, prod, etc.).
  2. Workflow: deploy the desired version on the same environment — immediate effect after confirmation.
  3. Control: monitor the traces in the first minutes or hours.

Update a deployment​

To update a deployment with a new version:

  1. Go to the Deployments tab
  2. Select the new version to deploy in the desired environment
  3. Click Deploy

Remove a deployment​

Removing a deployment

Removing a deployment immediately stops the workflow in that environment. All executions in progress will be interrupted. Make sure this does not impact your critical processes before removing a deployment.

To remove a deployment:

  1. Go to the Deployments tab
  2. Click Delete the deployment next to the deployment
  3. Confirm the action

Result​

Once the deployment is confirmed, the workflow is immediately active on the chosen environment: executions are driven by the trigger on this environment.

The Deployments tab displays:

  • The environments where the workflow is deployed
  • The status of each deployment
  • The deployed version
  • The deployment date

In the workflows table, the deployment state is readable at a glance: a green tag indicates the workflow is deployed, a grey tag shows the deployment environment.

Next steps​

See also: Workflows · Create a workflow · Variable management