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-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update discord with embed information (#16136)

Browse Source 
Update discord with embed information
This commit is contained in:
popboxgun 2021-01-27 10:41:21 +00:00 committed by GitHub
parent 6a2d4fa439
commit 814253e735
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
source/_integrations/discord.markdown
View File

@ -65,6 +65,30 @@ Right click channel name and copy the channel ID (**Copy ID**).
This channel or user ID has to be used as the target when calling the notification service. Multiple channel or user IDs can be specified, across multiple servers or direct messages. This channel or user ID has to be used as the target when calling the notification service. Multiple channel or user IDs can be specified, across multiple servers or direct messages.
### Discord Service Data
The following attributes can be placed inside the `data` key of the service call for extended functionality:
| Attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `images` | yes | The file(s) to attach to message.
| `embed` | yes | Array of [Discord embeds](https://discordpy.readthedocs.io/en/latest/api.html#embed). *NOTE*: if using `embed`, `message` is still required.
To include messages with embedding, use these attributes underneath the `embed` key:
| Attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `title` | yes | Title of the embed.
| `description` | yes | Description of the embed.
| `color` | yes | Color code of the embed. This value is an *int*.
| `url` | yes | URL of the embed.
| `author` | yes | Sets the footer for the embed content.
| `footer` | yes | Sets the footer for the embed content.
| `thumbnail` | yes | Sets the thumbnail for the embed content.
| `fields` | yes | Adds a field to the embed object. `name` and `value` are *required*, `inline` is *true* by default.
#### Example service call #### Example service call
```yaml ```yaml
@ -78,6 +102,40 @@ This channel or user ID has to be used as the target when calling the notificati
- "/tmp/garage.jpg" - "/tmp/garage.jpg"
``` ```
#### Example embed service call
```yaml
- service: notify.discord
data:
message: ""
target: ["1234567890", "0987654321"]
data:
embed:
title: 'title'
description: 'description'
url: 'https://www.home-assistant.io'
color: 199363
author:
name: 'Author Home Assistant'
url: 'https://www.home-assistant.io'
icon_url: 'https://www.home-assistant.io/images/favicon-192x192-full.png'
footer:
text: 'Footer Text'
icon_url: 'https://www.home-assistant.io'
thumbnail:
url: 'https://www.home-assistant.io/images/favicon-192x192-full.png'
fields:
- name: 'fieldname1'
value: 'valuename1'
inline: false
- name: 'fieldname2'
value: 'valuename2'
- name: 'fieldname3'
value: 'valuename3'
- name: 'fieldname4'
value: 'valuename4'
inline: false
```
### Notes ### Notes
You can tag any user inside a channel by using their user ID in the message like so: `<@userid>` replacing `userid` with the ID you copied. To get the user ID right click on the user name to copy the ID like you did for the channel ID up above. You can tag any user inside a channel by using their user ID in the message like so: `<@userid>` replacing `userid` with the ID you copied. To get the user ID right click on the user name to copy the ID like you did for the channel ID up above.