Notifications Microsoft Power Automate / Workflows

Aperçu

• Source: https://www.microsoft.com/power-platform/products/power-automate
• 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

Selon l’endroit où vous souhaitez voir apparaître votre notification, vous devez créer un workflow adapté. Par exemple, un workflow MS Teams peut ressembler à ceci :

La documentation correspondante se trouve ici.

Une fois terminé, cela générera une URL ressemblant à ceci :

https://prod-NO.LOCATION.logic.azure.com:443/workflows/WFID/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=SIGNATURE
       |-------------------------------| |-|             |                                                                                                  |
                    |                     |          {workflow}                                                                                          {signature}
             host information {host}      |
                                         {port}

Oui, l’URL est effectivement aussi longue… mais au final elle correspond à :

• workflows://{host}:{port}/{workflow}/{signature}

Astuce

Apprise prend également cette URL en charge telle quelle ; vous n’avez donc plus besoin de la reparser. Il existe toutefois un léger surcoût interne si vous l’utilisez ainsi. Parfois, le copier-coller reste malgré tout la solution la plus simple.

Syntaxe

La syntaxe valide est la suivante :

• https://prod-site.logic.azure.com:443/workflows/{workflow}/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig={signature}
• workflows://{host}:{port}/{workflow}/{signature}

Détail des Paramètres

Variable	Requis	Description
workflow	Oui	L’identifiant de workflow fourni dans le lien webhook Azure.
signature	Oui	L’identifiant de signature fourni dans le lien webhook Azure, c’est-à-dire sig=.
wrap	Non	Enveloppe le texte du corps dans la réponse.
ver	Non	Version d’API Power Automate à utiliser ; la valeur par défaut est 2016-06-01. Cette valeur peut aussi être lue via le mot-clé api-version présent dans le lien webhook Azure.
template	Non	Permet d’indiquer le chemin vers un template que vous préférez utiliser à la place de la carte Adaptive choisie par Apprise. Utilisez des doubles accolades {{token}} pour marquer les jetons à remplacer avant soumission au service amont, par exemple {{app_body}} ou {{app_title}}.

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 Microsoft Teams :

# Assuming our {host} is prod-site.logic.azure.com
# Assuming our {port} is 443
# Assuming our {workflow} is T1JJ3T3L2@DEFK543
# Assuming our {signature} is TIiajkdnlazkcOXrIdevi7F
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   workflows:///prod-site.logic.azure.com:443/T1JJ3T3L2@DEFK543/TIiajkdnlazkcOXrIdevi7F/

Modèles

L’Argument d’URL template

Définissez un argument ?template= pointant vers une charge utile JSON prédéfinie que vous souhaitez fournir au workflow. Dans l’idéal, vous pouvez rester sur le format AdaptiveCards.

Les Jetons de Modèle

Le template= que vous indiquez peut soit être entièrement rempli et prêt à être utilisé tel quel, soit être alimenté dynamiquement à chaque appel Apprise. Pour cela, utilisez des doubles accolades {{ et }} autour d’un mot-clé de votre choix, comme dans l’exemple ci-dessous :

{
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "type": "AdaptiveCard",
  "version": "1.5",
  "body": [
    {
      "type": "TextBlock",
      "text": "{{app_title}}",
      "weight": "Bolder",
      "separator": true
    },
    {
      "type": "TextBlock",
      "text": "{{app_body}}",
      "wrap": true
    }
  ]
}

Dans l’exemple ci-dessus, nous introduisons plusieurs jetons : app_id, app_title, target et whence. Certaines entrées seront TOUJOURS définies et ne peuvent pas être surchargées :

• app_id : l’identifiant de l’application, généralement défini à Apprise, même si un développeur peut le surcharger.
• app_desc : la description de l’application, souvent une variante un peu plus explicite de app_id. Elle vaut généralement Apprise Notification sauf surcharge.
• app_color : un code hexadécimal représentant la couleur associée au message. Par exemple, les messages info sont souvent bleus, tandis que les messages warning sont orange.
• app_type : le type du message lui-même, comme info, warning, success, etc.
• app_title : le titre réel transmis à la notification Apprise via --title ou -t.
• app_body : le corps réel transmis à la notification Apprise via --body ou -b.
• app_image_url : l’URL de l’image associée au type de message, par exemple info ou warning, si elle existe et n’a pas été désactivée dans l’URL via image=no.
• app_url : l’URL associée à l’instance Apprise, trouvée dans l’objet AppriseAsset(). Sauf surcharge explicite, sa valeur est https://github.com/caronc/apprise.

Tout ce que vous inventez en dehors de cela vous appartient. Revenons donc à target et whence. Les jetons de template peuvent être définis dynamiquement en utilisant l’opérateur : devant les arguments d’URL de votre choix. Par exemple :

• workflows://credentials/?template=/path/to/template.json&:target=Chris&:whence=this%20afternoon
• workflows://credentials/?template=http://host/to/template.json&:target=Chris&:whence=this%20afternoon

Une notification comme celle-ci :

# En utilisant des deux-points, nous pouvons definir dynamiquement
# target et whence depuis la ligne de commande :
apprise -t "Mon Titre va dans app_title" -b "Ceci est place dans app_body" \
   "workflows://credentials/?template=http://host/to/template.json&:target=Chris&:whence=this%20afternoon"

Publierait dans MSTeams en suivant le template ci-dessus :

{
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "type": "AdaptiveCard",
  "version": "1.0",
  "body": [
    {
      "type": "TextBlock",
      "text": "{{app_title}}",
      "weight": "Bolder",
      "separator": true
    },
    {
      "type": "TextBlock",
      "text": "{{app_body}}",
      "wrap": true
    },
    {
      "type": "TextBlock",
      "text": "Hello {{ target }}, how are you {{ whence }}?",
      "wrap": true
    }
  ]
}

Remarques Supplémentaires sur les Modèles

• Les jetons peuvent contenir des espaces autour d’eux pour améliorer la lisibilité. Ainsi, {{ token }} n’est pas différent de {{token}}.
• Tous les jetons sont correctement échappés ; ne vous inquiétez donc pas si une valeur contient un guillemet double ("), il sera correctement échappé avant l’envoi en amont.
• Les jetons sont sensibles à la casse. Ainsi, {{Token}} doit être alimenté par une valeur :Token= dans votre URL.
• Les jetons qui ne correspondent à rien ne sont tout simplement pas remplacés, et {{keyword}} restera tel quel dans le message.
• Apprise exige toujours au minimum un --body (-b), qui peut éventuellement être référencé sous {{app_body}} dans votre template. Même si vous ne l’utilisez pas, vous devez tout de même fournir une valeur pour satisfaire cette exigence et utiliser les appels de template.