2024.11.0
Home ▸ Integrations ▸

Microsoft Teams

The Microsoft Teams platform allows you to send notifications from Home Assistant to a team channel in Microsoft Teams.

Note

Please note that Microsoft announced the retirement of the Office 365 connectors within Microsoft Teams. Existing connectors will continue to work until December 2025.

Setup

To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more].

Configuration

To add the Microsoft Teams platform to your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

notify:
  - platform: msteams
    url: https://outlook.office.com/webhook/<ID>

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

Setting this parameter allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME action.

url string Required

The webhook URL created in the setup step.

Microsoft Teams service data

The following attributes can be placed inside data for extended functionality.

Data attribute Optional Description
image_url yes Attach an image to the message.

The image must be an HTTPS URL, and as outlined by Microsoft in the Documentation, the picture must be on a publicly available location.

Example for posting file from URL:

title: Title of the message.
message: Message that will be added.
data:
  image_url: URL_OF_IMAGE