feat(octopus): add Octopus Deploy integration by zakaneki · Pull Request #3221 · superplanehq/superplane

zakaneki · 2026-02-22T21:36:25Z

Summary

This PR adds a base integration with Octopus Deploy, allowing users to trigger workflows from deployment events and start release deployments directly from SuperPlane.

Demo

Loom walkthrough: https://www.loom.com/share/acf60dceb634468691c00f8f6a648bb4

Features

Authentication

API key authentication via the X-Octopus-ApiKey header.
Supports space-level configuration (custom Space ID or defaults to Spaces-1).

Trigger: On Deployment Event

Automatically creates Subscriptions in Octopus using the API.
Uses a unique naming convention (SuperPlane-{webhookID}) to avoid collisions between workflow nodes.
Verifies X-SuperPlane-Webhook-Secret to ensure payload authenticity.

Action: Deploy Release

Triggers a deployment for a selected Release and Environment.
Implements a 30s polling mechanism to track deployment status if webhooks fail or are delayed.
Provides Success and Failed outputs for conditional workflow branching.

Technical Decisions

Polling fallback
Although Octopus supports task completion webhooks, a polling loop is implemented in the Deploy Release action to prevent workflows from hanging if a webhook is dropped. This aligns with other long-running integrations (e.g., Render).
Isolated Subscriptions per trigger node
Each "On Deployment Event" node creates its own Subscription. This enables granular filtering (e.g., different environments per node) without cross-event noise.

How to Test

Prerequisites

An Octopus Deploy instance (Cloud or Server).
ngrok for local webhook testing.

Configure Connection

Add a new Octopus connection.
Provide:
- Server URL (e.g., https://example.octopus.app)
- API Key (generated in Profile → My API Keys)

Test Trigger

Add the "On Deployment Event" node.
Create a deployment in Octopus.
Verify the workflow triggers.

Test Action

Add the "Deploy Release" node.
Select a Project, Release, and Environment.
Run the workflow and confirm the deployment starts in Octopus.

pkg/integrations/octopus/deploy_release.go

pkg/integrations/octopus/webhook_handler.go

pkg/integrations/octopus/deploy_release.go

pkg/integrations/octopus/on_deployment_event.go

pkg/integrations/octopus/deploy_release.go

pkg/integrations/octopus/client.go

pkg/integrations/octopus/deploy_release.go

pkg/integrations/octopus/client.go

AleksandarCole · 2026-02-23T13:13:07Z

@zakaneki looking good - moved to code review

forestileao · 2026-02-23T18:04:27Z

pkg/integrations/octopus/deploy_release.go

+	for _, id := range deploymentIDs {
+		found, err := findExecutionByDeploymentID(ctx, id)
+		if err != nil {
+			return okResponse()
+		}
+		if found != nil {
+			executionCtx = found
+			break
+		}


Is it possible that this may drop a valid match when Octopus sends multiple deployment IDs in one event?

What your tests shows?

Yes, it's hard to test in practice because it's an edge case. Definitely an oversight though, thanks!

forestileao · 2026-02-23T19:15:23Z

pkg/integrations/octopus/common.go

+		return metadata
+	}
+
+	if projectID != "" && !strings.Contains(projectID, "{{") {


we can make this nested if into a function, right? its the same verification for all 3 resources.
projectId, releaseId, and environmentId

forestileao · 2026-02-23T19:22:33Z

pkg/integrations/octopus/deploy_release.go

+	DeployReleasePayloadType          = "octopus.deployment.finished"
+	DeployReleaseSuccessOutputChannel = "success"
+	DeployReleaseFailedOutputChannel  = "failed"
+	DeployReleasePollInterval         = 30 * time.Second


Let's increase this to 5 minutes. Like github workflow run and semaphore run workflow. Since we are using polling just as fallback

forestileao · 2026-02-23T19:23:14Z

pkg/integrations/octopus/deploy_release.go

+func (c *DeployRelease) Cancel(ctx core.ExecutionContext) error {
+	return nil
+}


Cancelling the execution should also cancel the deploy on the octopus side

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

pkg/integrations/octopus/on_deployment_event.go

- Adds base client with API Key auth and Space-level configuration - Adds 'On Deployment Event' trigger with webhook signature verification - Adds 'Deploy Release' action with dual output channels (success/failed) - Implements task polling fallback (30s interval) for reliable deployment tracking - Includes full integration documentation and JSON payload examples Signed-off-by: Andrija Zakić <[email protected]>

cursor bot reviewed Feb 22, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Outdated Show resolved Hide resolved

pkg/integrations/octopus/webhook_handler.go Show resolved Hide resolved

cursor bot reviewed Feb 22, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Outdated Show resolved Hide resolved

pkg/integrations/octopus/deploy_release.go Show resolved Hide resolved

cursor bot reviewed Feb 22, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Show resolved Hide resolved

cursor bot reviewed Feb 22, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Show resolved Hide resolved

pkg/integrations/octopus/on_deployment_event.go Show resolved Hide resolved

cursor bot reviewed Feb 22, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Show resolved Hide resolved

zakaneki force-pushed the feat/octopus-deploy-integration branch from bd9febe to ad56868 Compare February 23, 2026 00:01

cursor bot reviewed Feb 23, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Outdated Show resolved Hide resolved

pkg/integrations/octopus/client.go Outdated Show resolved Hide resolved

zakaneki force-pushed the feat/octopus-deploy-integration branch from ad56868 to 09c8bdf Compare February 23, 2026 00:22

cursor bot reviewed Feb 23, 2026

View reviewed changes

pkg/integrations/octopus/deploy_release.go Show resolved Hide resolved

pkg/integrations/octopus/client.go Outdated Show resolved Hide resolved

AleksandarCole added pr:stage-2/3 Needs to pass functional review edu labels Feb 23, 2026

AleksandarCole self-assigned this Feb 23, 2026

AleksandarCole self-requested a review February 23, 2026 08:51

zakaneki force-pushed the feat/octopus-deploy-integration branch from 09c8bdf to c3314a7 Compare February 23, 2026 11:10

AleksandarCole assigned forestileao and unassigned AleksandarCole Feb 23, 2026

AleksandarCole requested review from forestileao and removed request for AleksandarCole February 23, 2026 13:12

AleksandarCole added pr:stage-3/3 Ready for full, in-depth, review and removed pr:stage-2/3 Needs to pass functional review labels Feb 23, 2026

forestileao reviewed Feb 23, 2026

View reviewed changes

zakaneki force-pushed the feat/octopus-deploy-integration branch 2 times, most recently from 88510ff to 9c59377 Compare February 24, 2026 21:22

cursor bot reviewed Feb 24, 2026

View reviewed changes

pkg/integrations/octopus/on_deployment_event.go Show resolved Hide resolved

zakaneki force-pushed the feat/octopus-deploy-integration branch from 9c59377 to ba2f18a Compare February 24, 2026 21:35

Comments

Conversation

zakaneki commented Feb 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Demo

Features

Authentication

Trigger: On Deployment Event

Action: Deploy Release

Technical Decisions

How to Test

Prerequisites

Configure Connection

Test Trigger

Test Action

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AleksandarCole commented Feb 23, 2026

Uh oh!

forestileao Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

zakaneki Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

forestileao Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

forestileao Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

forestileao Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zakaneki commented Feb 22, 2026 •

edited

Loading