mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
---
|
|
layout: page
|
|
title: "Slack"
|
|
description: "Instructions how to add Slack notifications to Home Assistant."
|
|
date: 2015-08-06 18:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: slack.png
|
|
ha_category: Notifications
|
|
ha_release: pre 0.7
|
|
---
|
|
|
|
|
|
The `slack` platform allows you to deliver notifications from Home Assistant to [Slack](https://slack.com/).
|
|
|
|
You need to obtain the [Slack API token](https://api.slack.com/web?sudo=1) to be able to send notifications.
|
|
|
|
To enable the slack notification in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
name: NOTIFIER_NAME
|
|
platform: slack
|
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
|
default_channel: '#general'
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
|
- **api_key** (*Required*): The slack API token to use for sending slack messages. You can get your slack API token here https://api.slack.com/web?sudo=1
|
|
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message.
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
|
|