Notifications Google Chat

Aperçu

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

Configuration du Compte

Pour que cela fonctionne correctement, vous avez besoin d’un compte GSuite (des essais gratuits existent si vous n’en avez pas). Vous devez ensuite créer un webhook, comme suit :

1. Ouvrez Google Chat dans votre navigateur
2. Accédez à la salle à laquelle vous souhaitez ajouter un robot.
3. Dans le menu de la salle en haut de la page, sélectionnez Manage webhooks.
4. Donnez-lui un nom et un avatar facultatif, puis cliquez sur SAVE
5. Copiez l’URL associée à votre nouveau webhook.
6. Cliquez en dehors de la boîte de dialogue pour fermer.

Une fois l’opération terminée, vous obtiendrez une URL ressemblant à ceci :

https://chat.googleapis.com/v1/spaces/AAAAkM/messages?key=AIzaSSjMm-WEfqKqqsHI&token=O7bnyri_WEXKcyFk%3D
                                      ^    ^              ^                  ^       ^                 ^
                                      |    |              |                  |       |                 |
                                     workspace             ... webhook_key...         ..webhook_token..

Sous une forme simplifiée, cela donne :

• https://chat.googleapis.com/v1/spaces/WORKSPACE/messages?key=WEBHOOK_KEY&token=WEBHOOK_TOKEN

Il est important de noter que, même si ce plugin Apprise utilise gchat://, vous pouvez aussi utiliser directement l’URL exactement telle qu’elle vous a été fournie par Google lors du copier-coller. C’est également une URL Google Chat Apprise parfaitement valide.

Syntaxe

La syntaxe valide est la suivante :

• https://chat.googleapis.com/v1/spaces/{workspace}/messages?key={webhook_key}&token={webhook_token}
• gchat://{workspace}/{webhook_key}/{webhook_token}

Détail des Paramètres

Variable	Requis	Description
workspace	Oui	L’espace de travail associé à votre compte Google Chat.
webhook_key	Oui	La clé webhook associée à votre compte Google Chat.
webhook_token	Oui	Le jeton webhook associé à votre compte Google Chat.
thread	Non	Vous pouvez facultativement spécifier une ThreadKey dans l’URL afin de concentrer les notifications sur ce fil.

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 Google Chat :

# Supposons que notre {workspace} soit AAAAkM
# Supposons que notre {webhook_key} soit AIzaSSjMm-WEfqKqqsHI
# Supposons que notre {webhook_token} soit O7bnyri_WEXKcyFk%3D

apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   gchat://AAAAkM/AIzaSSjMm-WEfqKqqsHI/O7bnyri_WEXKcyFk%3D

Rappel : vous pouvez aussi utiliser directement l’URL telle qu’elle vous a été fournie lors de la configuration de votre webhook. Envoyer une notification Google Chat :

# Supposons que notre {workspace} soit AAAAkM
# Supposons que notre {webhook_key} soit AIzaSSjMm-WEfqKqqsHI
# Supposons que notre {webhook_token} soit O7bnyri_WEXKcyFk%3D

apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   https://chat.googleapis.com/v1/spaces/AAAAkM/messages?key=AIzaSSjMm-WEfqKqqsHI&token=O7bnyri_WEXKcyFk%3D

Vous souhaitez cibler une threadKey précise ? Faites simplement ceci :

# Supposons que notre {workspace} soit AAAAkM
# Supposons que notre {webhook_key} soit AIzaSSjMm-WEfqKqqsHI
# Supposons que notre {webhook_token} soit O7bnyri_WEXKcyFk%3D
# Supposons que notre {threadkey} soit ABC

apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   gchat://AAAAkM/AIzaSSjMm-WEfqKqqsHI/O7bnyri_WEXKcyFk%3D/?thread=ABC