Notifications Flock

Aperçu

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

Configuration du Compte

Flock présente de nombreuses similitudes avec Slack. Les notifications Flock nécessitent un incoming-webhook ou une application/bot à laquelle se connecter.

Webhook Entrant

Vous pouvez générer un webhook entrant depuis ici. Suivez simplement l’assistant pour prédéterminer le ou les canaux vers lesquels votre message sera diffusé. Une fois ce processus terminé, vous recevrez une URL similaire à celle-ci : https://api.flock.com/hooks/sendMessage/134b8gh0-eba0-4fa9-ab9c-257ced0e8221

Cela correspond effectivement à : https://api.flock.com/hooks/sendMessage/{token}

Remarque : Apprise prend en charge cette URL telle quelle (depuis la v0.7.7) ; il n’est plus nécessaire d’analyser l’URL davantage. Toutefois, cela entraîne légèrement moins de surcharge (en interne) si vous le faites.

Dans cet exemple, le token est 134b8gh0-eba0-4fa9-ab9c-257ced0e8221

Robot

Les bots sont un peu plus complexes et supposent que vous avez suivi leurs instructions pour configurer votre propre application. Comme pour un webhook, vous obtiendrez votre propre {token} qui vous permettra d’envoyer des messages directement à des personnes et des canaux.

Syntaxe

La syntaxe valide avec un webhook entrant est la suivante :

• https://api.flock.com/hooks/sendMessage/{token}
• flock://{token}/
• flock://{botname}@{token}/

La syntaxe valide avec une application / bot est la suivante : Remarque : le userid et le channelid correspondent à l’identifiant encodé réel et non à la valeur affichée publiquement. Par exemple, si vous avez un canal appelé #general, il aura un identifiant encodé qui ressemble à quelque chose comme g:abcd1234defg. Les utilisateurs sont identifiés de manière similaire mais sont préfixés par u: au lieu de g:. Ce sont ces valeurs que vous devez spécifier ici :

• flock://{token}/u:userid
• flock://{botname}@{token}/u:{user}
• flock://{botname}@{token}/u:{user1}/u:{user2}/u:{userN}/
• flock://{botname}@{token}/g:{channel}
• flock://{token}/g:{channel}
• flock://{botname}@{token}/g:{channel1}/g:{channel2}/g:{channelN}/
• flock://{botname}@{token}/g:{channel}/u:{user}/

Détail des Paramètres

Variable	Requis	Description
token	Oui	La première partie des 3 tokens fournis après la création d’un incoming-webhook et/ou d’une application/bot.
botname	Non	Identifie le nom du bot qui doit émettre le message. Si aucun n’est spécifié, le comportement par défaut est d’utiliser votre compte (associé au incoming-webhook).
channel	Non	Les canaux doivent être préfixés par un dièse # ou g:. Ils doivent représenter l’identifiant encodé du nom du canal (et non la référence lisible par l’humain). Vous pouvez spécifier autant de canaux que vous le souhaitez en les séparant par une barre oblique (/) dans l’URL.
user	Non	Les utilisateurs doivent être préfixés par un symbole arobase @ ou u:! Ils doivent représenter l’identifiant encodé du nom d’utilisateur (et non la référence lisible par l’humain). Vous pouvez spécifier autant d’utilisateurs que vous le souhaitez en les séparant par une barre oblique (/) dans l’URL.
image	Non	Associe une image au message. Par défaut, cette option est activée.

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 Flock à notre canal #nuxref (identifié comme g:abcd1234efgh) :

# Assuming our {token} is 134b8gh0-eba0-4fa9-ab9c-257ced0e8221
# our channel nuxref is represented as g:abcd1234efgh
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   flock:///134b8gh0-eba0-4fa9-ab9c-257ced0e8221/g:abcd1234efgh