Notifications Discord

Aperçu

• Source: https://discordapp.com/
• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 2000
• Créer votre URL Apprise

Configuration du Compte

Creer un compte Discord est simple. La seule etape demandant un peu plus de travail intervient une fois votre salon configure, Discord vous place par defaut dans un salon #General. Cliquez sur l’icone en forme d’engrenage, Settings, puis activez les webhooks a partir de la.

Le webhook ressemblera a quelque chose comme ceci : https://discordapp.com/api/webhooks/4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js

Cela correspond en pratique a : https://discordapp.com/api/webhooks/{WebhookID}/{WebhookToken}

Remarque : Apprise prend cette URL en charge telle quelle, depuis la v0.7.7. Vous n’avez donc plus besoin de l’analyser davantage. Cela dit, il y a un peu moins de surcharge interne si vous le faites.

La derniere partie de l’URL fournie constitue les 2 jetons dont vous avez besoin pour envoyer des notifications. Dans l’exemple ci-dessus, les jetons sont les suivants :

1. WebhookID est 4174216298
2. WebhookToken est JHMHI8qBe7bk2ZwO5U711o3dV_js

Mentionner des roles, tags et utilisateurs

Le corps du message Discord peut contenir des elements comme les suivants pour declencher les pings appropries :

• user: <@123>
• role: <@&456>
• tag: @everyone

Syntaxe

La syntaxe valide est la suivante :

• https://discordapp.com/api/webhooks/{WebhookID}/{WebhookToken}
• discord://{WebhookID}/{WebhookToken}/
• discord://{botname}@{WebhookID}/{WebhookToken}/

Discord prend egalement en charge differents arguments web. Les valeurs ci-dessous correspondent aux valeurs par defaut et n’ont donc pas besoin d’etre precisees, sauf si vous souhaitez les remplacer :

• discord://{WebhookID}/{WebhookToken}/?tts=No&avatar=Yes&footer=No&image=Yes

Détail des Paramètres

Variable	Obligatoire	Description
WebhookID	Oui	Premiere partie des 2 jetons qui vous sont fournis apres la creation d’un incoming-webhook.
WebhookToken	Oui	Seconde partie des 2 jetons qui vous sont fournis apres la creation d’un incoming-webhook.
botname	Non	Nom du robot qui doit publier le message. Si aucune valeur n’est fournie, la valeur par defaut consiste a utiliser simplement votre compte, associe a l’incoming-webhook.
tts	Non	Active le Text-To-Speech. La valeur par defaut est No.
footer	Non	Inclut un pied de message. La valeur par defaut est No.
image	Non	Inclut une image dans le message afin de representer le type de notification. La valeur par defaut est Yes.
avatar	Non	Remplace l’icone d’avatar Discord par defaut par une icone identifiant le type de notification. La valeur par defaut est Yes.
avatar_url	Non	Remplace l’URL de l’icone d’avatar Discord par defaut. Si elle n’est pas definie, Apprise choisit dynamiquement l’URL en fonction du type de message, info, success, warning ou error.
format	Non	La valeur par defaut est text. Si vous souhaitez toutefois gerer vous-meme le formatage, vous pouvez definir cette valeur sur markdown. Si le mode est defini sur markdown, Apprise analysera les lignes d’en-tete, generalement seules et entourees de hashtags #, puis les placera dans des objets embarques afin d’obtenir une presentation plus elegante.
href	Non	Definit une URL vers laquelle le titre doit pointer lors de la publication de la notification Discord. Cela force le message au format markdown afin de tirer parti de la section embeds de Discord. Vous pouvez aussi utiliser url= comme alias.
thread	Non	Permet facultativement de definir le thread_id auquel appliquer votre message.
ping	Non	Permet facultativement d’indiquer un role, un utilisateur ou un nom interprete, comme everyone, qui devra toujours etre pingue lors de l’envoi du message. Suivez la syntaxe identifiee ci-dessus pour le format attendu.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
redirect	Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.
retry	Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait	Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. L’appel global notify() retourne quand même True même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Exemples

Envoyer une notification Discord :

# Supposons que notre {WebhookID} soit 4174216298
# Supposons que notre {WebhookToken} soit JHMHI8qBe7bk2ZwO5U711o3dV_js
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js"

Si vous souhaitez utiliser votre propre URL d’avatar personnalisee, deja hebergee sur un autre site web, vous pouvez definir ceci :

# Supposons que notre {WebhookID} soit 4174216298
# Supposons que notre {WebhookToken} soit JHMHI8qBe7bk2ZwO5U711o3dV_js
# Supposons que notre {AvatarURL} soit https://i.imgur.com/FsEpmwg.jpeg
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js?avatar_url=https://i.imgur.com/FsEpmwg.jpeg"

Envoyer une notification qui notifie @everyone dans le salon :

# Supposons que notre {WebhookID} soit 4174216298
# Supposons que notre {WebhookToken} soit JHMHI8qBe7bk2ZwO5U711o3dV_js
apprise -vv -t "Bonjour a Tous" -b "Message de Test that pings @everyone" \
   "discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js"

Envoyer une notification exploitant la prise en charge integree de markdown par Discord :

# Supposons que notre {WebhookID} soit 4174216298
# Supposons que notre {WebhookToken} soit JHMHI8qBe7bk2ZwO5U711o3dV_js
cat << _EOF | apprise -vv "discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js?format=markdown"
# Title

- Bullet 1
- Bullet 2
- Bullet 3
_EOF