Notifications HumHub

Aperçu

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

Configuration du compte

HumHub est un reseau social autohberge destine aux equipes. Pour utiliser ce plugin, vous avez besoin d’une instance HumHub en cours d’execution avec le module REST API installe et actif.

Jeton Bearer (recommande)

1. Connectez-vous a votre instance HumHub en tant qu’administrateur.
2. Accedez a Administration > Modules et confirmez que le module REST API est active.
3. Allez dans Administration > Authentification > REST API > Authentification Bearer.
4. Activez l’authentification par jeton Bearer et generez un nouveau jeton.
5. Copiez le jeton genere — c’est votre {token}.

Authentification de base

Vous pouvez egalement vous authentifier directement avec votre nom d’utilisateur et votre mot de passe HumHub. Aucune configuration supplementaire n’est necessaire au-dela d’un compte HumHub valide.

Trouver un identifiant de conteneur

Chaque espace HumHub possede un identifiant de conteneur numerique. Pour le trouver :

1. Naviguez vers l’espace dans votre instance HumHub.
2. L’identifiant apparait dans l’URL de l’espace, par exemple https://yourhost/s/mon-espace-42 — le numero final est l’identifiant du conteneur.
3. Vous pouvez egalement interroger l’API REST : GET /api/v1/space renvoie tous les espaces avec leurs identifiants.

Syntaxe

La syntaxe valide est la suivante :

• humhubs://{token}@{hostname}/{container_id}
• humhubs://{user}:{password}@{hostname}/{container_id}
• humhubs://{token}@{hostname}/{id1}/{id2}/{id3}
• humhubs://{token}@{hostname}/?to={id1},{id2}
• humhubs://{token}@{hostname}:{port}/{container_id}
• humhub://{token}@{hostname}/{container_id}

Utilisez humhubs:// pour les connexions HTTPS (recommande) et humhub:// pour le HTTP simple.

Detail des parametres

Variable	Obligatoire	Description
hostname	*Oui	Le nom d’hote ou l’adresse IP de votre instance HumHub.
token	*Oui	Un jeton Bearer genere dans le panneau d’administration HumHub (utilise en l’absence de mot de passe).
user	*Oui	Votre nom d’utilisateur HumHub (utilise avec password pour l’authentification de base).
password	Non	Votre mot de passe HumHub. Lorsqu’il est fourni, l’authentification de base est utilisee a la place du jeton Bearer.
container_id	*Oui	L’identifiant numerique de l’espace HumHub (conteneur) ou publier. Plusieurs identifiants peuvent etre separes par / dans le chemin de l’URL, ou fournis sous forme de liste separee par des virgules via ?to=.
to	Non	Alias de container_id. Accepte une liste d’identifiants de conteneurs separes par des virgules, utile dans les fichiers de configuration YAML ou les cibles basees sur le chemin ne sont pas pratiques.
port	Non	Le port sur lequel votre instance HumHub ecoute. La valeur par defaut est 80 pour humhub:// et 443 pour humhubs://.

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.
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é. L’appel global notify() retourne quand même True 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 avec un jeton Bearer :

# En supposant que le nom d'hote HumHub soit hub.exemple.com
# En supposant que le jeton Bearer soit montoken123
# En supposant que l'identifiant du conteneur soit 5
apprise -vv -t "Alerte" -b "Un evenement s'est produit" \
    "humhubs://montoken123@hub.exemple.com/5"

Envoyer a plusieurs espaces en une seule URL :

apprise -vv -t "Alerte" -b "Un evenement s'est produit" \
    "humhubs://montoken123@hub.exemple.com/1/5/12"

Envoyer avec l’authentification de base :

apprise -vv -t "Alerte" -b "Un evenement s'est produit" \
    "humhubs://admin:monmotdepasse@hub.exemple.com/5"

Envoyer via HTTP (non securise, a utiliser uniquement en developpement ou sur un reseau local) :

apprise -vv -t "Alerte" -b "Un evenement s'est produit" \
    "humhub://montoken123@hub.local/5"