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
114 changes: 114 additions & 0 deletions docs/cloud/integrations/alerts/ms-teams-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: "Microsoft Teams (App)"
---

Elementary's Microsoft Teams app sends alerts when data issues happen, as
[Adaptive Cards](https://adaptivecards.io/) with rich context. Unlike the
[webhook integration](/cloud/integrations/alerts/ms-teams), the app is installed
once per team — no per-channel webhooks to create — and Elementary posts to any
standard channel in that team.

You can create [alert rules](/features/alerts-and-incidents/alert-rules) to
distribute alerts to different channels and destinations.

<Frame>
<img src="/images/teams/hero-alert.png" alt="Elementary alert in a Microsoft Teams channel" width="500" />
</Frame>

## Connecting the Microsoft Teams app

<Steps>
<Step title="Install the Elementary app in Microsoft Teams">
**In Microsoft Teams**, open the app store and search for **Elementary**.
Install the app and add it to the team where you want to receive alerts.
</Step>

<Step title="Connect your Teams workspace to Elementary">
Once the bot is installed in a team, you should see this card.
Click **Connect to Elementary** to link this workspace to your
Elementary account.

<Frame>
<img src="/images/teams/welcome-card.png" alt="Elementary welcome card with Connect to Elementary button" width="500" />
</Frame>

This opens **Elementary** and connects the workspace automatically.
Connecting requires an Elementary user with the **Edit integrations**
permission — usually a user with the **Admin** role.

Once complete, you should see both:

**In Elementary** — a dialog confirming the workspace is connected:

<Frame>
<img src="/images/teams/connected-dialog.png" alt="Elementary dialog showing Microsoft Teams workspace is connected" width="500" />
</Frame>

**In Microsoft Teams** — a confirmation card in the channel:

<Frame>
<img src="/images/teams/teams-cards-after-connection.png" alt="Welcome and connected confirmation cards in Microsoft Teams" width="500" />
</Frame>

<Tip>
You can regenerate the connection link any time by typing
**`@Elementary connect`** in the channel.
</Tip>
</Step>

<Step title="Route alerts to channels">
**In Elementary**, pick a **Default channel** in the connected view to start
receiving alerts right away. Use
[alert rules](/features/alerts-and-incidents/alert-rules) to control which
alerts go to which channels.

<Note>
Setting a default channel automatically adds a default
[alert rule](/features/alerts-and-incidents/alert-rules) that sends all
failures to that channel. Alerts on warnings are not sent by default — to
change this, go to the `Alert Rules` page.
</Note>

</Step>
</Steps>

## Bot commands

**In Microsoft Teams**, mention the bot in any channel it's installed in:

- **`@Elementary help`** — what Elementary can do and how to get started.

<Frame>
<img src="/images/teams/help-card.png" alt="@Elementary help response" width="500" />
</Frame>

- **`@Elementary connect`** — a fresh link to connect the team to your Elementary account.

<Frame>
<img src="/images/teams/connect-command.png" alt="@Elementary connect response" width="500" />
</Frame>

## Supported channels

The app posts to **standard channels** in the team it's installed in. Private
and shared channels are not supported.

## Disconnecting

You can disconnect from either side:

- **From Elementary** — go to `Environments` → `Connect messaging app`, open the
**Microsoft Teams App** menu, and choose **Disconnect**. This unlinks the
workspace from your Elementary account and stops alerts. The app stays
installed in Teams — remove it there too if you want to fully uninstall.
- **In Microsoft Teams** — remove the Elementary app from the team
(`Manage team` → `Apps` → remove **Elementary**). This uninstalls the app, and
the integration then shows as disconnected **in Elementary**.

Either way, you can reconnect later from the welcome message or by typing
**`@Elementary connect`** in the channel.

<Note>
Each Teams team can be connected to a single Elementary account. If a team is
already connected to a different account, connecting it again is rejected.
</Note>
11 changes: 9 additions & 2 deletions docs/cloud/integrations/alerts/ms-teams.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
---
title: "Microsoft Teams"
title: "Microsoft Teams (Legacy webhook)"
---

Elementary's Microsoft Teams integration enables sending alerts when data issues happen.
<Warning>
The webhook integration is deprecated. For new setups, use the
[Microsoft Teams App](/cloud/integrations/alerts/ms-teams-app) instead —
it's easier to set up, requires no per-channel webhooks, and supports
richer alert cards.
</Warning>

Elementary's Microsoft Teams webhook integration enables sending alerts when data issues happen.
The alerts are sent using Adaptive Cards format, which provides rich formatting and interactive capabilities.

The alerts include rich context, and you can create [alert rules](/features/alerts-and-incidents/alert-rules) to distribute alerts to different channels and destinations.
Expand Down
Binary file added docs/images/teams/alert-rule-teams.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/connect-command.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/connected-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/connecting-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/help-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/hero-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/messaging-connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/messaging-picker.png
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.
Binary file added docs/images/teams/welcome-and-connected-cards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/teams/welcome-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@
"group": "Alerts & Incidents",
"pages": [
"cloud/integrations/alerts/slack",
"cloud/integrations/alerts/ms-teams-app",
"cloud/integrations/alerts/ms-teams",
"cloud/integrations/alerts/pagerduty",
"cloud/integrations/alerts/opsgenie",
Expand Down
Loading