Notifications Twist

Aperçu

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

Configuration du Compte

Connectez-vous ou créez un compte auprès du service Twist si vous n’en avez pas encore un.

L’essentiel avec le service Twist est que vous vous authentifiez toujours avec un {email} et un {password}. Apprise peut fonctionner avec Twist en connaissant simplement ces deux valeurs.

Syntaxe

La syntaxe valide est la suivante :

• twist://{password}:{email}
• twist://{email}/{password}

Remarque : Si aucun canal n’est spécifié, le canal #General est utilisé par défaut.

Vous pouvez également envoyer des messages à un ou plusieurs canaux :

• twist://{password}:{email}/#{channel}
• twist://{email}/{password}/#{channel}
• twist://{password}:{email}/#{channel1}/#{channel2}
• twist://{email}/{password}/#{channel1}/#{channel2}

Twist associe toujours votre compte à une équipe par défaut. Apprise la détermine pour vous et notifie par défaut les canaux que vous spécifiez au sein de celle-ci. Cependant, comme il est possible que votre identifiant/mot de passe soit associé à plusieurs équipes, vous pouvez utiliser le deux-points (:) comme délimiteur pour identifier explicitement l’équipe/canal à contacter.

• twist://{password}:{email}/#{team}:{channel}
• twist://{email}/{password}/#{team}:{channel}

Détail des Paramètres

Variable	Requis	Description
email	Oui	L’adresse e-mail associée à votre compte Twist lors de votre inscription.
password	Oui	Le mot de passe défini lors de votre inscription à Twist.
channel	Non	Le canal que vous souhaitez notifier. Si aucun n’est spécifié, le canal #General sera utilisé par défaut au sein de votre équipe par défaut. Vous pouvez optionnellement utiliser un deux-points (:) placé devant le nom du canal pour forcer l’envoi du message vers une équipe spécifique (si vous faites partie de plusieurs équipes).

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 Twist vers le canal #general associé à notre équipe par défaut.

# Assume:
#  - our {email} is test@example.com
#  - our {password} is abc123
#  - The {channel} is #general
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   twist://abc123:test@example.com/#general