Notifications Fluxer

Aperçu

• Source: https://fluxer.app/
• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 2000
• Format(s) de message pris en charge:
  • ✓TEXT
• Créer votre URL Apprise

Configuration du compte

Fluxer utilise des webhooks pour publier des notifications.

Une URL de webhook ressemble à ceci :

https://api.fluxer.app/webhooks/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV

Sa forme générale est la suivante : https://api.fluxer.app/webhooks/{WebhookID}/{WebhookToken}

Les deux dernières parties sont les jetons nécessaires pour envoyer des notifications :

1. WebhookID est 417429632418316298
2. WebhookToken est JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV

Mentionner des rôles, tags et utilisateurs

Fluxer prend en charge les mentions de style Discord. Vous pouvez les placer directement dans le corps du message :

• user : <@123>
• role : <@&456>
• tag : @everyone ou @here

Vous pouvez également forcer des pings via le paramètre URL ping= (voir ci-dessous).

Syntaxe

La syntaxe valide est la suivante :

• https://api.fluxer.app/webhooks/{WebhookID}/{WebhookToken}
• https://api.fluxer.app/v1/webhooks/{WebhookID}/{WebhookToken}
• fluxer://{WebhookID}/{WebhookToken}/
• fluxer://{botname}@{WebhookID}/{WebhookToken}/

Mode serveur privé

Fluxer peut être utilisé dans deux modes :

• mode=cloud (par défaut) : publie vers l’API Fluxer Cloud (https://api.fluxer.app)
• mode=private : publie vers l’hôte que vous spécifiez dans l’URL

Lorsque mode=private est utilisé, un hôte est requis :

• fluxer://{host}/{WebhookID}/{WebhookToken}/?mode=private
• fluxer://{host}:{port}/{WebhookID}/{WebhookToken}/?mode=private

Si mode=private est sélectionné mais que l’hôte contient fluxer.app, Apprise repassera automatiquement en mode=cloud.

Chemins d’API auto-hébergés

L’installation auto-hébergée officielle expose son API sous /api. Apprise utilise ce chemin par défaut :

• fluxers://{host}/{WebhookID}/{WebhookToken}
• fluxers://{host}:{port}/{WebhookID}/{WebhookToken}

Si votre API utilise un autre chemin, placez-le avant les détails du webhook :

• fluxers://{host}/{path}/{WebhookID}/{WebhookToken}
• fluxers://{host}:{port}/{path}/{WebhookID}/{WebhookToken}

Par exemple, /custom/api/webhooks/... devient fluxers://{host}/custom/api/{WebhookID}/{WebhookToken}.

Note

Utilisez path=/ lorsque l’API est exposée à la racine de l’hôte, par exemple pour joindre directement son conteneur.

Attention

Les chemins ne s’appliquent qu’aux serveurs auto-hébergés. Le mode cloud utilise toujours https://api.fluxer.app et les ignore.

Détail des paramètres

Variable	Requis	Description
WebhookID	Oui	La première partie des 2 jetons fournis lors de la création d’un webhook entrant
WebhookToken	Oui	La seconde partie des 2 jetons fournis lors de la création d’un webhook entrant
botname	Non	Indique le nom du robot qui doit émettre le message
host	Non	Nom d’hôte de votre serveur Fluxer privé (utilisé avec mode=private)
port	Non	Port de votre serveur Fluxer privé (utilisé avec mode=private)
path	Non	Chemin de l’API d’un serveur Fluxer privé (/api par défaut ; utilisez / pour la racine de l’hôte)
mode	Non	L’une des valeurs suivantes : cloud (par défaut) ou private
tts	Non	Activer la synthèse vocale (Text-To-Speech) (par défaut Non)
avatar	Non	Remplacer l’icône d’avatar par défaut par une icône identifiant le type de notification (par défaut Oui)
avatar_url	Non	Remplacer l’URL de l’icône d’avatar. Si non défini, Apprise choisit dynamiquement une URL en fonction du type de message
footer	Non	Inclure une section pied de page dans l’intégration (par défaut Non)
footer_logo	Non	Inclure le logo de pied de page Fluxer lorsque footer=yes (par défaut Oui)
image	Non	Inclure une image en ligne avec le message décrivant le type de notification (par défaut Non)
fields	Non	Utiliser des champs intégrés lors de la publication au format markdown (par défaut Oui)
format	Non	La valeur par défaut est text. Définir sur markdown pour activer l’analyse markdown vers intégration (les en-têtes sont convertis en intégrations)
href	Non	Identifier une URL vers laquelle le titre doit pointer lors de la publication. Vous pouvez également utiliser url= comme alias
thread	Non	Définir éventuellement le thread_id auquel vous souhaitez que votre message soit appliqué
thread_name	Non	Définir éventuellement le nom du fil de discussion lors de l’utilisation de thread=
ping	Non	Une liste séparée par des virgules d’utilisateurs, de rôles ou de jetons tels que everyone qui doivent toujours être mentionnés

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 une notification Fluxer :

# En supposant que {WebhookID} soit 417429632418316298
# En supposant que {WebhookToken} soit JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "fluxer://417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV"

Envoyer une notification en utilisant le formatage markdown vers intégration :

# En supposant que {WebhookID} soit 417429632418316298
# En supposant que {WebhookToken} soit JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV
cat << _EOF | apprise -vv \
  "fluxer://417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV?format=markdown"
# Titre

- Élément 1
- Élément 2
- Élément 3
_EOF

Envoyer une pièce jointe :

# En supposant que {WebhookID} soit 417429632418316298
# En supposant que {WebhookToken} soit JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o3dV_js
apprise -vv -b "Voici un fichier" \
  --attach=/path/to/file.png \
  "fluxer://417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV"

Publier vers un serveur Fluxer privé :

# En supposant que l'URL de votre webhook soit :
#   https://fluxer.example.com/api/webhooks/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV
apprise -vv -b "Test du serveur privé" \
  "fluxers://fluxer.example.com/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV"

Publier vers un serveur Fluxer privé avec un chemin d’API personnalisé :

# En supposant que l'URL de votre webhook soit :
#   https://fluxer.example.com/custom/api/webhooks/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV
apprise -vv -b "Test du serveur privé" \
  "fluxers://fluxer.example.com/custom/api/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV"

Publier vers un serveur Fluxer privé qui expose son API à la racine du nom d’hôte :

# En supposant que l'URL de votre webhook soit :
#   https://fluxer.example.com/webhooks/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV
apprise -vv -b "Test du serveur privé" \
  "fluxers://fluxer.example.com/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV?path=/"