Notifications Zulip

Aperçu

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

Configuration du compte

Pour utiliser Zulip, vous devez disposer d’un robot Zulip Chat ; consultez cette page pour plus de details. Au moment de la redaction de ce plugin, la procedure etait la suivante :

1. Depuis votre ordinateur, cliquez sur l’icone d’engrenage en haut a droite.
2. Selectionnez Settings.
3. Dans le menu de gauche, cliquez sur Your bots.
4. Cliquez sur Add a new bot.
5. Remplissez les champs puis cliquez sur Create bot.

Si vous connaissez l’{ID} de votre organisation, puisqu’il fait partie de votre URL zulipchat.com, vous pouvez aussi acceder aux informations de votre robot en visitant : https://ID.zulipchat.com/#settings/your-bots

Une fois le robot cree avec succes, vous pourrez recuperer son jeton API.

Syntaxe

La syntaxe valide est la suivante :

• zulip://{botname}@{organization}/{token}/
• zulip://{botname}@{organization}/{token}/{stream}
• zulip://{botname}@{organization}/{token}/{stream1}/{stream2}/{streamN}
• zulip://{botname}@{organization}/{token}/{email}
• zulip://{botname}@{organization}/{token}/{email1}/{email2}/{emailN}

Remarque : si ni {stream} ni {email} ne sont precises, le flux general est notifie par defaut.

Vous pouvez aussi melanger les entrees ci-dessus :

• zulip://{botname}@{organization}/{token}/{stream1}/{email1}/

Détail des Paramètres

Variable	Obligatoire	Description
organization	Oui	Organisation dans laquelle vous avez cree votre webhook. La partie finale .zulipchat.com n’est pas obligatoire ici, mais elle est prise en charge si vous la fournissez.
token	Oui	Jeton API fourni apres la creation du robot.
botname	Oui	Nom du robot associe a la cle API. La partie -bot du nom n’est pas obligatoire, mais elle est egalement prise en charge si vous la precisez.
email	Non	Adresse e-mail appartenant a l’un des utilisateurs ajoutes a votre organisation pour l’envoi d’un message prive.
stream	Non	Flux a notifier.

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 Zulip vers le flux #general, utilise par defaut :

# Supposons que notre {organization} soit apprise
# Supposons que notre {token} soit T1JJ3T3L2
# Supposons que notre {botname} soit goober
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   zulip:///goober@apprise/T1JJ3T3L2

Envoyer une notification Zulip vers le flux #support :

# Supposons que notre {organization} soit apprise
# Supposons que notre {token} soit T1JJ3T3L2
# Supposons que notre {stream} soit #support
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   zulip:///apprise/T1JJ3T3L2/support