diff --git a/public/docs/img/projects/built-in-step-templates/images/send-teams-message-step.png b/public/docs/img/projects/built-in-step-templates/images/send-teams-message-step.png new file mode 100644 index 0000000000..6a383931c9 Binary files /dev/null and b/public/docs/img/projects/built-in-step-templates/images/send-teams-message-step.png differ diff --git a/src/pages/docs/administration/managing-infrastructure/subscriptions/index.md b/src/pages/docs/administration/managing-infrastructure/subscriptions/index.md index 27c3502551..e22a43285a 100644 --- a/src/pages/docs/administration/managing-infrastructure/subscriptions/index.md +++ b/src/pages/docs/administration/managing-infrastructure/subscriptions/index.md @@ -7,7 +7,7 @@ description: Subscriptions allow you to subscribe to events that are happening w navOrder: 1600 --- -Subscriptions allow you to subscribe to events that are happening within Octopus, so you can be notified when events have occurred and react accordingly. **Email**, **webhook**, and **Slack** notifications are supported. +Subscriptions allow you to subscribe to events that are happening within Octopus, so you can be notified when events have occurred and react accordingly. **Email**, **webhook**, **Slack**, and **Microsoft Teams** notifications are supported. Subscriptions can be accessed from the `Configuration` menu. @@ -124,6 +124,14 @@ Public channels in your workspace are listed automatically. To post to a private For more information on what channels the Slack app can post to, see [public and private channels](/docs/administration/managing-infrastructure/slack-integration#slack-integration-channels). +## Microsoft Teams webhook notifications {#Subscriptions-TeamsNotifications} + +Microsoft Teams webhook notifications send a digest of events to one or more Teams channels via incoming webhooks. Available from Octopus Server version `2026.4.1197`. + +To configure Teams notifications on a subscription, add one or more channels under **Microsoft Teams notifications**. For each channel, enter a display name and paste the incoming webhook URL. Set the frequency to control how often digests are delivered. + +To create an incoming webhook URL for a Teams channel, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) in the Microsoft Teams documentation. + ## 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. diff --git a/src/pages/docs/projects/built-in-step-templates/send-teams-message.md b/src/pages/docs/projects/built-in-step-templates/send-teams-message.md new file mode 100644 index 0000000000..5c315b3516 --- /dev/null +++ b/src/pages/docs/projects/built-in-step-templates/send-teams-message.md @@ -0,0 +1,42 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2026-09-04 +modDate: 2026-09-04 +title: Send a Microsoft Teams Message step +description: Send a Microsoft Teams Message steps let you post messages to Microsoft Teams channels using incoming webhooks as part of a deployment or runbook process. +navOrder: 21 +--- + +The Send a Microsoft Teams Message step can be used to post a message to a Teams channel at any point in a deployment or runbook process, for example to report the outcome of a deployment or alert your team to a failure. + +The Send a Microsoft Teams Message step is available from Octopus Server version `2026.4.1197`. + +Each step targets one or more channels via incoming webhooks. You'll need a webhook URL for each channel before adding the step. To create one, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) in the Microsoft Teams documentation. + +:::figure +![The Send a Microsoft Teams Message step editor showing channel configuration and message fields.](/docs/img/projects/built-in-step-templates/images/send-teams-message-step.png) +::: + +## Add the step + +1. Navigate to your project's deployment process and click **Add step**. +2. Search for and select **Send a Microsoft Teams Message**. +3. Give the step a name. +4. Add one or more channels. For each, enter a display name and the incoming webhook URL. You can use an [Octopus variable](/docs/projects/variables/variable-substitutions) for the URL if you want to vary it per environment or tenant. +5. Enter the message to post. +6. Set conditions to control when the step runs. +7. Save the deployment process. + +## Message content {#send-teams-message-formatting} + +The message field supports [Octopus variable substitution](/docs/projects/variables/variable-substitutions). + +### Example + +```text +#{Octopus.Project.Name} #{Octopus.Release.Number} to #{Octopus.Environment.Name} has #{if Octopus.Deployment.Error}failed#{else}completed successfully#{/if}. [View deployment](#{Octopus.Web.ServerUri}#{Octopus.Web.DeploymentLink}) +``` + +:::div{.hint} +See [system variables](/docs/projects/variables/system-variables) for the full list of variables available during a deployment. +:::