mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Discord docs (#2923)
* Add screenshots and re-arrange instructions * Add 'ha_release'
This commit is contained in:
parent
61fe6a5150
commit
486f08d5fe
@ -9,16 +9,15 @@ sharing: true
|
||||
footer: true
|
||||
logo: discord.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.37
|
||||
---
|
||||
|
||||
The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows components to send messages to the user using Discord.
|
||||
|
||||
In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a bot user. Retreive the client ID and the (hidden) token of your bot for later.
|
||||
In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a [bot](https://discordapp.com/developers/docs/topics/oauth2#bots) user (**Create a Bot User**) and activate **Require OAuth2 Code Grant**. Retreive the **Client ID** and the (hidden) **Token** of your bot for later.
|
||||
|
||||
When setting up the application you can use this [icon](https://home-assistant.io/demo/favicon-192x192.png).
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To use Discord notifications, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -34,16 +33,31 @@ Configuration variables:
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **token** (*Required*): Your bot's token.
|
||||
|
||||
### {% linkable_title Using the bot %}
|
||||
Bots can only send messages to servers. To add the bot to a server you are an admin on, use the Discord OAuth2 Authorization page:
|
||||
### {% linkable_title Setting up the bot %}
|
||||
|
||||
[https://discordapp.com/api/oauth2/authorize?client_id=1234567890&scope=bot&permissions=0](https://discordapp.com/api/oauth2/authorize?client_id=1234567890&scope=bot&permissions=0)
|
||||
Bots can only send messages to servers. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me).
|
||||
|
||||
Replace the client ID with the appropriate one from the [Discord My Apps page](https://discordapp.com/developers/applications/me).
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/discord-bot.png' />
|
||||
</p>
|
||||
|
||||
Once the bot user has been added to your server, get the channel ID of the channel you want the bot to operate in.
|
||||
* In The Discord app go to Settings > Appearance > Check developer mode
|
||||
* Right click channel name > Copy ID
|
||||
Now use the Discord Authorization page with the **Client ID** of your [bot](https://discordapp.com/developers/docs/topics/oauth2#bots).
|
||||
|
||||
[https://discordapp.com/api/oauth2/authorize?client_id=[CLIENT_ID]&scope=bot&permissions=0](https://discordapp.com/api/oauth2/authorize?client_id=[CLIENT_ID]&scope=bot&permissions=0)
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/discord-auth.png' />
|
||||
</p>
|
||||
|
||||
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**.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/discord-api.png' />
|
||||
</p>
|
||||
|
||||
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.
|
||||
|
||||
@ -59,7 +73,7 @@ This channel ID has to be used as the target when calling the notification servi
|
||||
}
|
||||
```
|
||||
|
||||
### {% linkable_title Notes %}
|
||||
### {% linkable_title Notes %}
|
||||
|
||||
For more information about creating and authorizing bots, visit the [OAuth2 information page](https://discordapp.com/developers/docs/topics/oauth2)
|
||||
|
||||
|
BIN
source/images/screenshots/discord-api.png
Normal file
BIN
source/images/screenshots/discord-api.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
BIN
source/images/screenshots/discord-auth.png
Normal file
BIN
source/images/screenshots/discord-auth.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
BIN
source/images/screenshots/discord-bot.png
Normal file
BIN
source/images/screenshots/discord-bot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 32 KiB |
Loading…
x
Reference in New Issue
Block a user