Slack


The slack platform allows you to deliver notifications from Home Assistant to Slack.

Setup

Bot posting as you

  1. Create a new app under your Slack.com account.
  2. Click the OAuth & Permissions link in the sidebar, under the Features heading.
  3. In the Scopes section, add the chat:write scope, Send messages as user. If you get a missing_scope error when trying to send a message, check these permissions.
  4. Scroll up to OAuth Tokens & Redirect URLs and click Install App.
  5. Copy your OAuth Access Token and put that key into your configuration.yaml file – see below.

There is an app credential Verification Token on the Basic Settings of your app. This is not the API key you want.

Bot posting as its own user

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.

Configuration

To enable the Slack notification in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: slack
    api_key: YOUR_API_KEY
    default_channel: '#general'

Configuration Variables

name string (Optional, default: notify)

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

api_key string Required

The Slack API token to use for sending Slack messages.

default_channel string Required

The default channel to post to if no channel is explicitly specified when sending the notification message. A channel can be specified adding a target attribute to the JSON at the same level as “message”.

username string (Optional)

Home Assistant will post to Slack using the username specified.

Default:

The user account or botname that you generated the API key as.

icon string (Optional)

Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used here. Alternatively a publicly accessible URL may be used.

Note that in order to modify your Slack bot’s username and icon, you must ensure your Slack app has the chat:write.customize OAuth scope. See the Slack API documentation for more information.

Slack Service Data

The following attributes can be placed inside the data key of the service call for extended functionality:

Attribute Optional Description
username yes The username of the Slack bot.
icon yes The icon of the Slack bot.
file yes A file to include with the message; see below.
file yes A file to include with the message; see below.
blocks yes Array of Slack blocks. NOTE: if using blocks, they are shown in place of the message (note that the message is required nonetheless).
blocks_template yes The same as blocks, but able to support templates.

Note that using file will ignore all usage of blocks and blocks_template (as Slack does not support those frameworks in messages that accompany uploaded files).

To include a local file with the Slack message, use these attributes underneath the file key:

Attribute Optional Description
path no A local filepath that has been whitelisted.

To include a remote file with the Slack message, use these attributes underneath the file key:

Attribute Optional Description
url no A URL that has been whitelisted.
username yes An optional username if the URL is protected by HTTP Basic Auth.
password yes An optional password if the URL is protected by HTTP Basic Auth.

Examples

To send a file from local path:

message: Message that will be added as a comment to the file.
title: Title of the file.
data:
  file:
    path: /path/to/file.ext

To send a file from remote path:

message: Message that will be added as a comment to the file.
title: Title of the file.
data:
  file:
    url: "http://site.com/image.jpg"

To send a file from remote path that is protected by HTTP Basic Auth:

message: Message that will be added as a comment to the file.
title: Title of the file.
data:
  file:
    url: "http://site.com/image.jpg"
    username: user
    password: pass

To use the block framework:

message: Fallback message in case the blocks don't display anything.
title: Title of the file.
data:
  blocks:
    - type: section
      text:
        type: mrkdwn
        text: 'Danny Torrence left the following review for your property:'
    - type: section
      block_id: section567
      text:
        type: mrkdwn
        text: "<https://example.com|Overlook Hotel> \n :star: \n Doors had too many
          axe holes, guest in room 237 was far too rowdy, whole place felt stuck in
          the 1920s."
      accessory:
        type: image
        image_url: https://is5-ssl.mzstatic.com/image/thumb/Purple3/v4/d3/72/5c/d3725c8f-c642-5d69-1904-aa36e4297885/source/256x256bb.jpg
        alt_text: Haunted hotel image
    - type: section
      block_id: section789
      fields:
      - type: mrkdwn
        text: |-
          *Average Rating*
          1.0