Discord is a part of the notifier plugin system.
This plugin is used to send notification to a discord server using the webhook functionnality.
| Option | Type | Description | Default |
|---|---|---|---|
| web_hook_url | url | Server webhook url. Required | |
| username | text | override the default username of the webhook | Flexget |
| avatar_url | url | override the default avatar of the webhook | |
| embeds | array | embeded content |
Examples show a specifc scenario usage of the notify plugin. See its wiki for a more detailed usage exaplantion.
The following configuration send a webhook message to a discord server containing embeds object. Refer to Embed object documentation for more information on how to use them.
notify:
entries:
message: "{{series_name}} - {{series_id }}"
via:
- discord:
web_hook_url: https://discordapp.com/api/webhooks/XXXXXXXXXXX/YYYYYYYYYY
avatar_url: https://avatars2.githubusercontent.com/u/17483320?s=400&v=4
username: "Flexget"
embeds:
- title: "{{series_name}}"
description: "{{tvmaze_series_summary|default('Unknown')}}"
url: "{{tvmaze_series_url}}"
color: 0xe67e22
author:
name: "Flexget"
url: "https://flexget.com"
icon_url: "https://i.imgur.com/R66g1Pe.jpg"
fields:
- name: "Episode Name:"
value: "{{tvmaze_episode_name|default('Unknown')}}"
inline: True
- name: "Score"
value: "{{tvmaze_series_rating|default('Unknown')}}"
inline: True
- name: "Made in"
value: ":flag_jp:"
thumbnail:
url: "{{tvdb_ep_image|default('https://i.imgflip.com/j69nf.jpg')}}"
image:
url: "{{tvmaze_series_original_image}}"