Notifications Rocket.Chat

Aperçu

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

Syntaxe

Rocket.Chat peut envoyer des notifications via les modes suivants :

• webhook : un webhook entrant configuré ; il peut être mis en place dans la zone Administration sous la rubrique Intégrations.
• basic : une combinaison identifiant/mot de passe.

Les connexions sécurisées (via https) doivent être référencées avec rockets:// tandis que les connexions non sécurisées (via http) doivent utiliser rocket://.

Mode Basique

La syntaxe valide est la suivante :

• rocket://{user}:{password}@{hostname}/#{channel}
• rocket://{user}:{password}@{hostname}:{port}/#{channel}
• rocket://{user}:{password}@{hostname}/{room_id}
• rocket://{user}:{password}@{hostname}:{port}/{room_id}
• rockets://{user}:{password}@{hostname}/#{channel}
• rockets://{user}:{password}@{hostname}:{port}/#{channel}
• rockets://{user}:{password}@{hostname}/{room_id}
• rockets://{user}:{password}@{hostname}:{port}/{room_id}

Remarque : l’option ?avatar=yes ne fonctionnera que si votre utilisateur possède le paramètre de permission bot.

Vous pouvez également combiner les formes ci-dessus et effectuer des mises à jour depuis une seule URL :

• rocket://{user}:{password}@{hostname}/#{channel_id}/{room_id}

Pour le Mode Basique uniquement : si ni {room_id} ni #{channel} n’est spécifié, cette notification échouera.

Mode Webhook

La syntaxe valide est la suivante :

• rocket://{webhook}@{hostname}/#{channel}
• rocket://{webhook}@{hostname}/{room_id}
• rocket://{webhook}@{hostname}/{@user}
• rockets://{webhook}@{hostname}/#{channel}
• rockets://{webhook}@{hostname}:{port}/#{channel}
• rockets://{webhook}@{hostname}/{room_id}
• rockets://{webhook}@{hostname}:{port}/{room_id}

Vous pouvez également combiner les formes ci-dessus et effectuer des mises à jour depuis une seule URL :

• rocket://{webhook}@{hostname}:{port}/#{channel_id}/{room_id}/@{user}

Par défaut, un webhook est configuré pour être associé à un canal. La syntaxe suivante est donc également valide :

• rocket://{webhook}@{hostname}/

Remarque : Certains webhooks contiennent des barres obliques. Dans ce cas, vous devez vous assurer d’échapper la barre oblique (/) avec %2F. Votre URL peut donc ressembler à :

• rocket://abcd%2F12345@{hostname}/ - Notez le %2F (pour remplacer le / présent dans le webhook)

Détail des Paramètres

Variable	Requis	Description
user	*Oui	L’identifiant utilisateur associé à votre serveur Rocket.Chat. Requis uniquement si vous ne fournissez pas de webhook. Peut être combiné optionnellement avec le webhook si vous souhaitez remplacer le nom du robot.
password	*Oui	Le mot de passe associé à votre serveur Rocket.Chat. Requis uniquement si vous ne fournissez pas de webhook. Cette valeur peut également se substituer à un jeton prégénéré.
webhook	*Oui	Le webhook entrant que vous avez créé et associé à votre serveur Rocket.Chat. Requis uniquement si vous ne fournissez pas de webhook à la place.
hostname	Oui	Le serveur Rocket.Chat auquel vous envoyez votre notification.
port	Non	Le port sur lequel le serveur Rocket.Chat écoute. Par défaut, le port est 80 pour rocket:// et 443 pour toutes les références rockets://.
room_id	Non	Un identifiant de salon. Disponible pour les modes basic et webhook.
channel	Non	Les canaux doivent être préfixés par un dièse (#) sinon ils seront interprétés comme un identifiant de salon. Disponible pour les modes basic et webhook. Les canaux doivent être enregistrés sur votre serveur Rocket.Chat pour fonctionner.
user_id	Non	Un autre utilisateur à notifier. Les identifiants utilisateur doivent être préfixés par le symbole arobase (@). Disponible pour le mode webhook uniquement.
mode	Non	Le mode d’authentification est détecté automatiquement d’après l’URL fournie. Vous n’avez à le définir que si vous estimez qu’il est mal détecté. Les modes possibles sont basic, token et webhook, décrits ci-dessus.
avatar	Non	Remplace l’avatar par défaut associé au message pour correspondre au type de notification (Avertissement, Erreur, Info, etc.). Par défaut, cette option est Non pour le mode basic et Oui pour le mode webhook.

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.
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.

Exemples

Envoyer une notification Rocket.Chat vers le canal #nuxref :

# Supposons que notre {user} soit l2g
# Supposons que notre {password} soit awes0m3!
# Supposons que notre {hostname} soit rocket.server.local
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   rocket://l2g:awes0m3!@rocket.server.local/#nuxref