Teams setup for Elementary CLI

Elementary Teams integration includes sending Teams alerts on failures in dbt tests and models. The alerts are sent using Microsoft Teams Adaptive Cards format, which provides rich formatting and interactive capabilities.

Integration options

There are two ways to create a webhook for Microsoft Teams:

1. Microsoft Teams Connectors (Legacy): The traditional way of creating webhooks, but this method is being deprecated by Microsoft.
2. Power Automate Workflows (Recommended): The newer, more flexible way to create webhooks. Note that when using this method, Elementary CLI cannot directly verify if messages were delivered - you’ll need to monitor your workflow runs in Power Automate.

Below is a features support comparison table (with Slack), to help you select the integration method.

Integration	Elementary alerts	Elementary report	Multiple channels
Teams Connector (Legacy)	✅	❌	❌
Power Automate Workflows	✅	❌	❌

Note: Microsoft 365 Connectors (previously called Office 365 Connectors) are nearing deprecation. We recommend using Power Automate Workflows for new integrations.

Teams integration setup

First create a Microsoft Teams team:

Create a new Team

Create a new Team

Go to the Microsoft Teams desktop app and create a new team.

Create a team from from a template and use the From Scratch template.

Choose Public as the kind of a team.

Call it Elementary (or whatever you prefer) and connect it to the workspace of your choice.

Now it's time to set up a webhook. You have two options for creating a webhook:

Option 1: Create Teams Webhook using Connectors (Legacy)

Create a webhook using Connectors

Note: Microsoft 365 Connectors are being deprecated. Consider using Power Automate Workflows (Option 2) for new integrations.

Go to a channel in your Team and choose Manage channel

Choose Edit connectors.

Search for Incoming webhook and choose Add.

Choose Add again and add name your webhook ElementaryWebhook (or whatever you prefer). And Create the webhook.

Copy the URL of the webhook.

Option 2: Create Teams Webhook using Power Automate (Recommended)

Create a webhook using Power Automate

You can create a webhook using Power Automate in two ways:

Method 1: Directly from Teams (Recommended)

1. Go to your Teams channel
2. Click the three dots (...) next to the channel name
3. Select Workflows
4. Choose the template "Post to channel when a webhook request is received"
5. Copy the webhook URL

Method 2: From Power Automate Website

1. Go to Power Automate
2. Create a new instant cloud flow
3. Search for "When a HTTP request is received" as your trigger
4. In the flow, add a "Post adaptive card in a chat or channel" action
5. Configure the team and channel where you want to post
6. Save the flow and copy the HTTP POST URL

Important Notes:

• When using Power Automate Workflows, Elementary CLI cannot directly verify if messages were successfully delivered. You'll need to monitor your workflow runs in Power Automate to check for any delivery issues.
• Workflows can't post in private channels as a flow bot, but can post on behalf of a user
• Workflows can only be created in your default environment

Lastly, pass the webhook URL (from either method) to the CLI as a param or in the config.yml file:

Teams config as CLI params

Webhook:

Use the webhook URL when you execute edr monitor using the option -tw, --teams-webhook:

edr monitor --teams-webhook <your_teams_webhook_url>

Teams config as in config.yml

The CLI reads the Teams integration from a file, copy it into a file called config.yml. Create it here: HOME_DIR/.edr/config.yml

Here is the format in the yml itself:

Webhook:

config.yml

teams:
  teams_webhook: <your_teams_webhook_url>