jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 14:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for forthcoming Slack functionality (block templating) (#13184)

Browse Source
This commit is contained in:
Aaron Bach 2020-05-18 12:00:39 -06:00 committed by GitHub
parent c811733fae
commit 6dcfd81ecc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/_integrations/slack.markdown
View File

@ -26,6 +26,7 @@ There is an app credential Verification Token on the Basic Settings of your app.
</div> </div>
### Bot posting as its own user ### 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. 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. Don't forget to invite the bot to the room where you want to get the notifications.
@ -76,7 +77,8 @@ The following attributes can be placed inside `data` for extended functionality.
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `file` | yes | Local path of file, photo, etc. to post to Slack. | `file` | yes | Local path of file, photo, etc. to post to Slack.
| `attachments` | yes | Array of [Slack attachments](https://api.slack.com/messaging/composing/layouts#attachments) (legacy). *NOTE*: if using `attachments`, they are shown **in addition** to `message`. | `attachments` | yes | Array of [Slack attachments](https://api.slack.com/messaging/composing/layouts#attachments) (legacy). *NOTE*: if using `attachments`, they are shown **in addition** to `message`.
| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in addition** to `message`. | `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *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](https://www.home-assistant.io/docs/configuration/templating).
Example for posting a file from local path: Example for posting a file from local path:
@ -92,7 +94,7 @@ Please note that `file` is validated against the `whitelist_external_dirs` in th
Example for using the block framework: Example for using the block framework:
```yaml ```yaml
message: Message that will be added as a comment to the file. message: Fallback message in case the blocks don't display anything.
title: Title of the file. title: Title of the file.
data: data:
blocks: blocks:
@ -130,11 +132,3 @@ data:
- title: WHAT A HORRIBLE NIGHT TO HAVE A CURSE. - title: WHAT A HORRIBLE NIGHT TO HAVE A CURSE.
image_url: https://i.imgur.com/JEExnsI.gif image_url: https://i.imgur.com/JEExnsI.gif
``` ```
You can also use YAML to send messages from your automations
Please note that both `message` is a required key, but is always shown, so use an empty (`""`) string for `message` if you don't want the extra text.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
Extra information: You must add the bot to your Slack channel, otherwise you can't send messages in this channel.