Env0 Integration

💡 NOTE: For the latest details and examples, see the Overmind Env0 plugin repository on GitHub: overmindtech/env0-plugin and the Env0 plugin documentation at Env0 Plugins Overview.

The Overmind Env0 plugin lets you connect your Env0 Terraform deployments directly to Overmind. It:

Submits Terraform plans from Env0 to Overmind for blast radius and risk analysis
Tracks change lifecycle, marking when a deployment starts and finishes
Links changes back to Env0, so every change in Overmind has a ticket link to the corresponding Env0 deployment

How It Works

The Env0 plugin runs as a standard Env0 version: 2 plugin defined in your env0.yaml:

Plugin installation – Env0 clones the public plugin repository and executes it as a Bash-based plugin.
Overmind CLI install – The plugin downloads and installs the latest Overmind CLI into a writable directory on the PATH.
Authentication – The api_key input is exported as OVERMIND_API_KEY so the CLI can authenticate.
Action execution – Based on the action input, the plugin runs one of:
- submit-plan: Uses the Env0-provided $ENV0_TF_PLAN_JSON to submit a Terraform plan to Overmind
- start-change: Marks the beginning of a change in Overmind
- end-change: Marks the completion of a change in Overmind
Ticket link – For all actions, the plugin builds a ticket link back to the Env0 deployment using Env0 environment variables (ENV0_PROJECT_ID, ENV0_ENVIRONMENT_ID, ENV0_DEPLOYMENT_LOG_ID, ENV0_ORGANIZATION_ID). This ticket link is attached to the Overmind change so you can always trace back to the original Env0 run.

Requirements

Before configuring the integration, ensure:

Overmind account with an API key that has the following scopes:
- account:read
- changes:write
- config:write
- request:receive
- sources:read
- source:write
Env0 environment variables are available at runtime (Env0 sets these automatically for Terraform runs):
- ENV0_PROJECT_ID
- ENV0_ENVIRONMENT_ID
- ENV0_DEPLOYMENT_LOG_ID
- ENV0_ORGANIZATION_ID
- ENV0_TF_PLAN_JSON – required for the submit-plan action
Terraform plan JSON – Env0 must be configured to produce a JSON plan (Env0 normally populates ENV0_TF_PLAN_JSON after a terraformPlan step).

Store your Overmind API key in Env0 as a secure environment variable (for example OVERMIND_API_KEY) and pass it to the plugin via the api_key input.

Plugin Inputs

The Env0 plugin exposes the following inputs:

Input	Description	Required
`action`	The action to perform. Must be one of: `submit-plan`, `start-change`, `end-change`.	Yes
`api_key`	Overmind API key used for authentication. Must have scopes: `account:read`, `changes:write`, `config:write`, `request:receive`, `sources:read`, `source:write`.	Yes
`tags`	Comma-separated `key=value` tags to attach to the change (only used with `submit-plan`).	No

Tags are useful for categorisation, for example:

environment=production
team=platform
service=billing

Basic Setup

Add the plugin to your env0.yaml and reference the public repository:

version: 2
deploy:
  steps:
    terraformPlan:
      after:
        - name: Submit Plan to Overmind
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: submit-plan
            api_key: ${OVERMIND_API_KEY}

In this example:

Env0 runs your normal terraformPlan step.
After the plan completes, the plugin:
- Uses ENV0_TF_PLAN_JSON to submit the plan to Overmind.
- Attaches Env0 deployment details as a ticket link.
- Creates or updates a Change in Overmind with blast radius and risk analysis.

You can optionally attach tags to the change:

version: 2
deploy:
  steps:
    terraformPlan:
      after:
        - name: Submit Plan to Overmind
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: submit-plan
            api_key: ${OVERMIND_API_KEY}
            tags: environment=production,team=platform

Tracking Change Lifecycle

To get full before/after snapshots and lifecycle tracking in Overmind, add the start-change and end-change actions around your terraformApply step.

Mark Change Started (before `terraformApply`)

Configure a before hook on terraformApply:

version: 2
deploy:
  steps:
    terraformApply:
      before:
        - name: Mark Change Started
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: start-change
            api_key: ${OVERMIND_API_KEY}

This will:

Look up the relevant Change in Overmind (typically created during submit-plan).
Mark it as started, capturing a snapshot of current infrastructure state.

Mark Change Finished (after `terraformApply`)

Configure an after hook on terraformApply:

version: 2
deploy:
  steps:
    terraformApply:
      after:
        - name: Mark Change Finished
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: end-change
            api_key: ${OVERMIND_API_KEY}

This will:

Mark the Change as completed in Overmind.
Capture a post-deployment snapshot to understand exactly what changed.
Keep the Env0 deployment ticket link associated with the Change for easy navigation.

Complete Example

Here is a complete env0.yaml example that uses all three actions:

version: 2
deploy:
  steps:
    terraformPlan:
      after:
        - name: Submit Plan to Overmind
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: submit-plan
            api_key: ${OVERMIND_API_KEY}
            tags: environment=production,team=platform

    terraformApply:
      before:
        - name: Mark Change Started
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: start-change
            api_key: ${OVERMIND_API_KEY}

      after:
        - name: Mark Change Finished
          use: https://github.com/overmindtech/env0-plugin
          inputs:
            action: end-change
            api_key: ${OVERMIND_API_KEY}

With this configuration:

Every Env0 plan is sent to Overmind for blast radius and risk analysis.
Every Env0 apply is tracked from start to finish in Overmind.
Each Change in Overmind includes a ticket link back to the Env0 deployment for full traceability.

Troubleshooting

If the plugin does not behave as expected, check the following:

Env0 plugin logs – Env0 shows plugin execution logs in the deployment details; look for Overmind-related errors.
API key scopes – Ensure the API key used in api_key has all required scopes.
Environment variables – Verify that Env0 is setting ENV0_TF_PLAN_JSON (for submit-plan) and other ENV0_* variables for your deployment.
Plugin path – The plugin uses ENV0_PLUGIN_PATH (as described in the Env0 plugin docs) to locate its files; ensure you are not overriding this in your environment.

For more advanced usage patterns or updates to the plugin behaviour, see the GitHub repository: https://github.com/overmindtech/env0-plugin.

How It Works​

Requirements​

Plugin Inputs​

Basic Setup​

Tracking Change Lifecycle​

Mark Change Started (before terraformApply)​

Mark Change Finished (after terraformApply)​

Complete Example​

Troubleshooting​