mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-10 04:58:59 +00:00
2b5d3c0c10
* Fix a bunch of typos/spelling mistakes * Removed extra spaces from emulated_hue * Correct device type. of binary_sensor.enocean.markdown
45 lines
2.1 KiB
Markdown
45 lines
2.1 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/).
|
|
|
|
If you are planning to use Slack as yourself then you need to obtain a [Slack API token](https://api.slack.com/web?sudo=1) to be able to send notifications.
|
|
|
|
It is also possible to use Slack bots as users. Just create a new bot at https://[YOUR_TEAM].slack.com/apps/build/custom-integration and use the provided token for that. You can add an icon from the frontend for Home Assistant and give the bot a meaningful name.
|
|
|
|
Don't forget to invite the bot to the room where you want to get the 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.
|
|
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message.
|
|
- **username** (*Optional*): Setting username will allow Home Assistant to post to Slack using the username specified. By default not setting this will post to Slack using the user account or botname that you generated the api_key as.
|
|
- **icon** (*Optional*): Use one of the Slack emoji's as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/).
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
|
|