Notifications Ryver

Aperçu

• Source: https://ryver.com/
• 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

Configuration du Compte

Pour utiliser Ryver, vous devez avoir créé au préalable le ou les forums que vous souhaitez notifier. Cette étape est nécessaire avant de suivre les instructions ci-dessous.

Ensuite, vous devez définir un nouveau webhook et obtenir l’URL correspondante. Pour ce faire :

1. Cliquez sur Integrations > Incoming Webhooks dans les paramètres à gauche.
2. Cliquez sur le bouton Create Webhook.
3. Choisissez soit Slack soit Plain/text Ryver, car ce plugin prend en charge les deux.
4. Quel que soit le type de webhook choisi (Slack ou Ryver), les étapes suivantes restent identiques :
   • Définissez le type de webhook sur Chat Message.
   • Sélectionnez le ou les forums déjà configurés pour autoriser l’accès à ce webhook.
   • Cliquez sur Suivant.

Une fois ce processus terminé, vous recevrez une URL similaire à celle-ci : https://apprise.ryver.com/application/webhook/ckhrjW8w672m6HG

Cela correspond effectivement à :
https://{organization}.ryver.com/application/webhook/{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.

La dernière partie de l’URL fournie est le token qui nous intéresse. Par rapport à l’exemple ci-dessus :

• le token est ckhrjW8w672m6HG
• l’organization est apprise

Syntaxe

La syntaxe valide est la suivante :

• https://{organization}.ryver.com/application/webhook/{token}
• ryver://{organization}/{token}/
• ryver://{botname}@{organization}/{token}/
• ryver://{organization}/{token}/?webhook=slack

Détail des Paramètres

Variable	Requis	Description
organization	Oui	L’organisation sous laquelle vous avez créé votre webhook.
token	Oui	Le token fourni après la création d’un incoming-webhook.
botname	Non	Définit le nom d’affichage depuis lequel le message apparaîtra.
webhook	Non	Le type de webhook créé (Slack ou Ryver). Les seules valeurs possibles sont slack et ryver. La valeur par défaut est ryver si aucune valeur webhook n’est spécifié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.
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 Ryver :

# Assuming our {organization} is apprise
# Assuming our {token} is T1JJ3T3L2
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   ryver:///apprise/T1JJ3T3L2