Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Blkio
bootstrap
bootstrapped
bootstrapper
bubblewrap
bufio
buildevent
buildinfo
Expand All @@ -69,6 +70,7 @@ choco
cicd
CIFS
classiclink
ClaudeCodeBehaviour
clientcertificate
cloudapi
cloudapp
Expand Down Expand Up @@ -131,6 +133,7 @@ Djava
Dockerfiles
dockerhub
Domainname
dontAsk
DONTVALIDATEPATH
dotmemory
dotnetcore
Expand All @@ -156,6 +159,7 @@ environmentids
eprintfn
esac
exfiltrate
exfiltration
expressjs
externalgroups
externalusers
Expand Down Expand Up @@ -239,6 +243,7 @@ ITSM
javac
jdbc
jjones
journalctl
jsondecode
JSSE
jwks
Expand Down Expand Up @@ -292,6 +297,7 @@ minifier
minlevel
MITM
Mkto
modelcontextprotocol
Moines
mozjpeg
mozroots
Expand Down Expand Up @@ -480,6 +486,8 @@ Runspace
runtimes
sakila
SAMEORIGIN
sandboxed
sandboxing
Schannel
SCIM
scopeduserroles
Expand Down Expand Up @@ -581,6 +589,7 @@ undeployed
undeploying
uniquestring
Unmarshal
unsandboxed
updateprogress
upgradeavailability
upgradelog
Expand Down Expand Up @@ -614,6 +623,7 @@ WEBSVR
westeurope
WFLYCTL
WFLYUT
wildcarded
Wildfly
windir
windowsfeatures
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1460,"height":1134,"updated":"2026-07-08T04:16:53.233Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1444,"height":290,"updated":"2026-07-08T04:16:53.246Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1460,"height":1434,"updated":"2026-07-08T04:16:53.270Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1944,"height":2148,"updated":"2026-07-08T04:16:53.292Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1460,"height":1548,"updated":"2026-07-08T04:16:53.327Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1944,"height":1056,"updated":"2026-07-08T04:16:53.357Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1460,"height":1478,"updated":"2026-07-08T04:16:53.409Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":680,"height":440,"updated":"2026-07-08T04:16:53.437Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1710,"height":1002,"updated":"2026-07-08T04:16:53.462Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":1130,"height":328,"updated":"2026-07-08T04:16:53.486Z"}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For earlier versions of Octopus, Subscriptions can be accessed from the **Config
:::

:::figure
![](/docs/img/administration/managing-infrastructure/subscriptions/images/subscriptions-menu.png)
![The Subscriptions page in the Octopus Configuration menu](/docs/img/administration/managing-infrastructure/subscriptions/images/subscriptions-menu.png)
:::

## Email notifications {#Subscriptions-EmailNotifications}
Expand All @@ -35,19 +35,20 @@ Let's say you have some critical projects and you want your administrators to re
Consider the following example:

:::figure
![](/docs/img/administration/managing-infrastructure/subscriptions/images/subscriptions-email-example.png)
![An example email subscription configured for deployment-critical events in the Production environment](/docs/img/administration/managing-infrastructure/subscriptions/images/subscriptions-email-example.png)
:::

We can select the _Deployment-critical events_ group, which will automatically filter all deployment-critical events for us.
We can select the *Deployment-critical events* group, which will automatically filter all deployment-critical events for us.

We can then select just the projects/environments we want to monitor. In this case: our _Infrastructure_ or _Code_ projects. Also, we only want to get notified when these critical events occur in our _Production_ environment.
We can then select just the projects/environments we want to monitor. In this case: our *Infrastructure* or *Code* projects. Also, we only want to get notified when these critical events occur in our *Production* environment.

So in this example, all users in the _Octopus Administrators_ team (with a valid email address) will receive an email notification for _Deployment-critical events_, in the _Infrastructure_ or _Code_ projects, that occurred in our _Production_ environment.
So in this example, all users in the *Octopus Administrators* team (with a valid email address) will receive an email notification for *Deployment-critical events*, in the *Infrastructure* or *Code* projects, that occurred in our *Production* environment.

:::div{.hint}
Each filter you add is an "AND," while each option you add to the filter is an "OR."

A subscription with the filters:

- Event Categories: Deployment Started
- Environments: Staging, Production
- Projects: Hello World
Expand All @@ -62,13 +63,12 @@ You can read more about getting started with notifications in our [Getting Start
In this example, we have also configured the timezone drop-down so all dates shown in the emails will be in our preferred timezone.
:::

We can then hit _Save_ and this subscription will show up in our subscriptions list screen.
We can then hit *Save* and this subscription will show up in our subscriptions list screen.

## Role permissions

Each email will be customized based on the user's roles, so they will only be emailed with events that they have permission to see. See the "Event Visibility and Permissions" section below for more details.


## Webhook notifications {#Subscriptions-WebhookNotifications}

Webhook notifications allow you to receive a JSON payload, posted to a specified URL when events have occurred. Webhook notifications will be sent **per event** (unlike email notifications that send a digest of events) and will include a payload with the following structure:
Expand All @@ -92,16 +92,16 @@ Webhook notifications allow you to receive a JSON payload, posted to a specified

The `Payload` includes:

| Property | Hint | Description |
| Property | Hint | Description |
| ---------------------------- | ---- | ----------- |
| ServerUri | \* | The Octopus Server that generated this webhook |
| ServerAuditUri | \* | The URL to the Octopus Server's audit screen where this event may be found in more detail |
| Subscription | | The subscription object that triggered this webhook (including all filtering criteria so you can see exactly why you are receiving this webhook) |
| Event | | The event object that this webhook is responding to |
| BatchProcessingDate | | The processing date for the current batch. For 'Single' payload types, the events will be sent in batches. The batch date is included here for your reference |
| BatchId | \** | A unique GUID given to the current batch of events being processed |
| TotalEventsInBatch | \** | The total number of events, in the current batch of events being processed |
| EventNumberInBatch | \** | The event number of this event, in the current batch of events being processed |
| ServerUri | \* | The Octopus Server that generated this webhook |
| ServerAuditUri | \* | The URL to the Octopus Server's audit screen where this event may be found in more detail |
| Subscription | | The subscription object that triggered this webhook (including all filtering criteria so you can see exactly why you are receiving this webhook) |
| Event | | The event object that this webhook is responding to |
| BatchProcessingDate | | The processing date for the current batch. For 'Single' payload types, the events will be sent in batches. The batch date is included here for your reference |
| BatchId | \** | A unique GUID given to the current batch of events being processed |
| TotalEventsInBatch | \** | The total number of events, in the current batch of events being processed |
| EventNumberInBatch | \** | The event number of this event, in the current batch of events being processed |

\* This property will be null unless the publicly-accessible URL has been set for your Octopus instance (see the **Configuration ➜ Nodes ➜ Configuration Settings** menu).

Expand All @@ -112,7 +112,6 @@ The `Payload` includes:
While we make every effort to ensure events are only ever sent *once* to a given email or webhook subscription, we can offer no guarantees and advise that you design your consuming API with this in mind.
:::


## Event visibility and permissions {#Subscriptions-Event-Visibility-and-Permissions}

Because certain teams may be restricted to only see certain events, subscriptions give you the ability to scope to one or more teams. Teams may be restricted to certain criteria, such as project(s) and/or environment(s). Combine these restrictions with team roles and you can successfully control which events get seen for a given subscription. See more information on [Managing Users and Teams](/docs/security/users-and-teams/) as well as our [User Roles](/docs/security/users-and-teams/user-roles) documentation if you wish to learn more.
Expand Down Expand Up @@ -229,84 +228,84 @@ The following is a list of all options for subscriptions including Event Groups,
| Task canceled |
| User password changed |

| DOCUMENT TYPES |
|--------------------------------------|
| Account |
| Action Template |
| Action Template Version |
| Api Key |
| Artifact |
| Auto Deploy Queue Item |
| Build Information |
| Certificate |
| Channel |
| Community Action Template |
| Connect Project to Tenants Task |
| Dashboard Configuration |
| Data Migration State |
| Deleted Space |
| Deployment |
| Deployment Completion |
| Deployment Environment |
| Deployment Freeze |
| Deployment Freeze Override |
| Deployment History |
| Deployment Process |
| Deployment Settings |
| Deployment Target Tag |
| Deprecation Usage |
| Event |
| Extension Configuration |
| Feature Toggle |
| DOCUMENT TYPES |
|---------------------------------------|
| Account |
| Action Template |
| Action Template Version |
| Api Key |
| Artifact |
| Auto Deploy Queue Item |
| Build Information |
| Certificate |
| Channel |
| Community Action Template |
| Connect Project to Tenants Task |
| Dashboard Configuration |
| Data Migration State |
| Deleted Space |
| Deployment |
| Deployment Completion |
| Deployment Environment |
| Deployment Freeze |
| Deployment Freeze Override |
| Deployment History |
| Deployment Process |
| Deployment Settings |
| Deployment Target Tag |
| Deprecation Usage |
| Event |
| Extension Configuration |
| Feature Toggle |
| Feature Toggle Publishing Signing Key |
| Feed |
| Git Credential |
| Git Hub App Connection |
| Git Hub App Token |
| Insights Report |
| Interruption |
| Invitation |
| Kubernetes Monitor |
| Kubernetes Resource Manifest |
| Kubernetes Task Resource Status |
| Library Variable Set |
| Lifecycle |
| Machine |
| Machine Policy |
| Octopus Server Node |
| Process Execution |
| Project |
| Project Group |
| Project Intents |
| Project Trigger |
| Proxy |
| Release |
| Runbook |
| Runbook Process |
| Runbook Run |
| Runbook Run History |
| Runbooks Snapshot |
| Sample Project |
| Scoped User Role |
| Server Task |
| Server Task Approval |
| Server Account Oidc Identity |
| Signing Key |
| Space |
| Subscription |
| Tag Set |
| Team |
| Tenant |
| Tenant Variable |
| User |
| User Favorite Project |
| User Onboarding |
| User Role |
| User Session |
| Variable Set |
| Worker |
| Worker Pool |
| Worker Task Lease |
| Feed |
| Git Credential |
| Git Hub App Connection |
| Git Hub App Token |
| Insights Report |
| Interruption |
| Invitation |
| Kubernetes Monitor |
| Kubernetes Resource Manifest |
| Kubernetes Task Resource Status |
| Library Variable Set |
| Lifecycle |
| Machine |
| Machine Policy |
| Octopus Server Node |
| Process Execution |
| Project |
| Project Group |
| Project Intents |
| Project Trigger |
| Proxy |
| Release |
| Runbook |
| Runbook Process |
| Runbook Run |
| Runbook Run History |
| Runbooks Snapshot |
| Sample Project |
| Scoped User Role |
| Server Task |
| Server Task Approval |
| Server Account Oidc Identity |
| Signing Key |
| Space |
| Subscription |
| Tag Set |
| Team |
| Tenant |
| Tenant Variable |
| User |
| User Favorite Project |
| User Onboarding |
| User Role |
| User Session |
| Variable Set |
| Worker |
| Worker Pool |
| Worker Task Lease |

\* License key expiry events are only available in Octopus Server version `2025.2.6402` and later.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/best-practices/deployments/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ If you are not careful with your subscription, you could end up with a lot of "n
Each filter you add is an "AND," while each option you add to the filter is an "OR."

A subscription with the filters:

- Event Categories: Deployment Started
- Environments: Staging, Production
- Projects: Hello World
Expand Down Expand Up @@ -61,4 +62,3 @@ For further reading on subscriptions and other notifications in Octopus Deploy p

- [Subscriptions](/docs/administration/managing-infrastructure/subscriptions)
- [Email Notifications](/docs/projects/built-in-step-templates/email-notifications)

Loading