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-16 13:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document sending Slack attachemnts (#3879)

Browse Source 
Support for Slack attachments was added in https://github.com/home-assistant/home-assistant/pull/2914 but never documented. Took me a minute to get to 😅
This commit is contained in:
Josh Nichols 2017-11-07 03:56:30 -05:00 committed by Fabian Affolter
parent 3365e091f4
commit a496a94227
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_components/notify.slack.markdown
View File

@ -52,8 +52,10 @@ The following attributes can be placed `data` for extended functionality.
| `username` | yes | Username if the url requires authentication. Is placed inside `file`. | `username` | yes | Username if the url requires authentication. Is placed inside `file`.
| `password` | yes | Password if the url requires authentication. Is placed inside `file`. | `password` | yes | Password if the url requires authentication. Is placed inside `file`.
| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`. | `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`.
| `attachments` | yes | Array of [Slack attachments](https://api.slack.com/docs/message-attachments). See [the attachment documentation](https://api.slack.com/docs/message-attachments) for how to format. *NOTE*: if using `attachments`, they are shown **in addition** to `message`
Example for posting file from URL:
Example for posting file from URL
```json ```json
{ {
"message":"Message that will be added as a comment to the file.", "message":"Message that will be added as a comment to the file.",
@ -68,7 +70,9 @@ Example for posting file from URL
} }
} }
``` ```
Example for posting file from local path
Example for posting file from local path:
```json ```json
{ {
"message":"Message that will be added as a comment to the file.", "message":"Message that will be added as a comment to the file.",
@ -82,5 +86,23 @@ Example for posting file from local path
``` ```
Please note that `path` is validated against the `whitelist_external_dirs` in the `configuration.yaml`. Please note that `path` is validated against the `whitelist_external_dirs` in the `configuration.yaml`.
Example for posting formatted attachment:
```json
{
"message": "",
"data": {
"attachments": [
{
"title": "WHAT A HORRIBLE NIGHT TO HAVE A CURSE.",
"image_url": "http://i.imgur.com/JEExnsI.gif"
}
]
}
}
```
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/). To use notifications, please see the [getting started with automation page](/getting-started/automation/).