aa7a018464
* Change i.e. and e.g. to i.e.,, and e.g., * Update textlintrc.json * Update .textlintrc.json Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * added i.e., Co-authored-by: Franck Nijhof <frenck@frenck.nl>
3.4 KiB
title, description, logo, ha_category, ha_release
| title | description | logo | ha_category | ha_release | |
|---|---|---|---|---|---|
| Discord | Instructions on how to add Discord notifications to Home Assistant. | discord.png |
|
0.37 |
The Discord service is a platform for the notify component. This allows integrations to send messages to the user using Discord.
In order to get a token you need to go to the Discord My Apps page and create a new application. Once the application is ready, create a bot user (Create a Bot User).
Retrieve the Client ID from the information section and the (hidden) Token of your bot for later.
When setting up the application you can use this icon.
To use Discord notifications, add the following to your configuration.yaml file:
# Example configuration.yaml entry
notify:
- platform: discord
token: YOUR_DISCORD_BOT_TOKEN
{% configuration %}
name:
description: The notifier will bind to the service notify.NAME.
required: false
type: string
default: notify
token:
description: Your bot's token.
required: true
type: string
{% endconfiguration %}
Setting up the bot
Bots can only send messages to servers or attach local available images. To add the bot to a server you are an admin on, get the details of the bot from the Discord My Apps page.
Now use the Discord Authorization page with the Client ID of your bot.
https://discordapp.com/api/oauth2/authorize?client_id=[CLIENT_ID]&scope=bot&permissions=0
Wait for the confirmation which should say "Authorized".
Once the bot has been added to your server, get the channel ID of the channel you want the bot to operate in. In The Discord application go to Settings > Appearance > Check developer mode.
Right click channel name and copy the channel ID (Copy ID).
This channel ID has to be used as the target when calling the notification service. Multiple channel IDs can be specified, across multiple servers.
Example service call
- service: notify.discord
data:
message: "A message from Home Assistant"
target: ["1234567890", "0987654321"]
data:
images:
- "/tmp/garage_cam"
- "/tmp/garage.jpg"
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.
For more information about creating and authorizing bots, visit the OAuth2 information page
To use notifications effectively, please see the getting started with automation page.
Images are uploaded to Discord when a message is sent. As such, a local path to the image is required (i.e., /config/www/garage.jpg as opposed to /local/garage.jpg), and updating an image after sending it in a message will not update the message in Discord.