Notifications Zoho Cliq

Aperçu

• Source: https://www.zoho.com/cliq/
• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 5000
• Format(s) de message pris en charge:
  • ✓MARKDOWN
• Créer votre URL Apprise

Configuration du compte

Les messages Zoho Cliq sont publiés à l’aide d’un jeton de webhook (Webhook Token) :

1. Connectez-vous à Zoho Cliq et ouvrez Bots & Tools, puis Webhook Tokens.
2. Terminez l’étape de vérification et cliquez sur Generate New Token.
3. Copiez le jeton. Il ressemble à 1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d.

Les messages peuvent être envoyés à un canal ou à un bot :

• Les canaux sont désignés par leur nom unique, affiché sur la page Channel Info du canal.
• Les bots sont désignés par leur nom unique précédé d’un @. Un message de bot arrive dans votre propre discussion avec le bot, sauf si broadcast=yes est défini : dans ce cas, chaque abonné du bot le reçoit.

Si votre compte n’est pas hébergé dans le centre de données américain, ajoutez region= à l’URL. L’adresse à laquelle vous vous connectez vous l’indique : par exemple, cliq.zoho.eu correspond à region=eu.

Vous pouvez aussi coller telle quelle une URL de webhook Cliq, par exemple https://cliq.zoho.com/api/v2/channelsbyname/{channel}/message?zapikey={token}.

Note

Les jetons de webhook permettent uniquement de publier des messages, les pièces jointes ne sont donc pas prises en charge.

Syntaxe

La syntaxe valide est la suivante :

• cliq://{token}/{channel}
• cliq://{token}/#{channel}
• cliq://{token}/@{bot}
• cliq://{botname}@{token}/#{channel1}/#{channel2}/@{bot}
• https://cliq.zoho.com/api/v2/channelsbyname/{channel}/message?zapikey={token}
• https://cliq.zoho.com/api/v2/bots/{bot}/message?zapikey={token}

Les schémas zcliq:// et zohocliq:// fonctionnent de la même façon que cliq://.

Détails des paramètres

Variable	Requis	Description
token	Oui	Votre jeton de webhook Zoho Cliq.
channel	*Non	Le nom unique d’un canal à notifier. Le # initial est facultatif.
bot	*Non	Le nom unique d’un bot à notifier, précédé d’un @.
botname	Non	Le nom d’expéditeur affiché sur le message. S’il n’est pas défini et que image=yes, le nom Apprise est utilisé.
region	Non	Le centre de données qui héberge votre compte. Les valeurs possibles sont us, eu, in, au, cn, jp, sa, uk et ca. La valeur par défaut est us.
company	Non	L’identifiant de votre entreprise, pour les comptes qui appartiennent à plusieurs entreprises. C’est le numéro qui suit /company/ dans votre adresse Cliq.
image	Non	Affiche comme image de l’expéditeur une icône correspondant au type de notification. Mettez no pour publier en votre propre nom. La valeur par défaut est yes.
broadcast	Non	Envoie les messages de bot à chaque abonné du bot. La valeur par défaut est no.

*Au moins un canal ou un bot doit être indiqué.

Paramètres Globaux

Variable	Description
overflow	Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream. 👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite. 👉 truncate : conserve la partie qui tient dans la limite et supprime le reste. 👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre. Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
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é. Le résultat global de notify() est quand même considéré comme réussi 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 un message au canal general :

apprise -vv -t "Sauvegarde terminée" -b "Tous les fichiers ont été copiés" \
   "cliq://1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/general"

Envoyer un message à un canal et à chaque abonné d’un bot, pour un compte hébergé en Europe :

apprise -vv -t "Espace disque" -b "db01 est utilisé à 95 %" \
   "cliq://Monitor@1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/#ops/@alertbot?region=eu&broadcast=yes"