2.3 KiB
title | description | ha_category | ha_iot_class | ha_release | ha_codeowners | ha_domain | ha_platforms | ha_integration_type | ha_quality_scale | |||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Microsoft Teams | Instructions on how to send a notification to a Microsoft Teams channel. |
|
Cloud Push | 0.101 |
|
msteams |
|
integration | legacy |
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.
{% endnote %}
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 {% term "configuration.yaml
" %}.
Configuration
To add the Microsoft Teams platform to your installation, add the following to your {% term "configuration.yaml
" %} file:
notify:
- platform: msteams
url: https://outlook.office.com/webhook/<ID>
{% configuration %}
name:
description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME
action.
required: false
type: string
default: "notify"
url:
description: The webhook URL created in the setup step.
required: true
type: string
{% endconfiguration %}
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