Passer au contenu principal

Mattermost

Statut : plugin intégré (jeton de bot + événements WebSocket). Les canaux, groupes et messages privés sont pris en charge. Mattermost est une plateforme de messagerie d’équipe auto-hébergeable ; consultez le site officiel à l’adresse mattermost.com pour les détails du produit et les téléchargements.

Plugin intégré

Mattermost est livré comme plugin intégré dans les versions actuelles d’OpenClaw, donc les builds packagés normaux ne nécessitent pas d’installation séparée. Si vous utilisez une ancienne build ou une installation personnalisée qui exclut Mattermost, installez-le manuellement : Installation via la CLI (registre npm) :
openclaw plugins install @openclaw/mattermost
Extraction locale (lors d’une exécution depuis un dépôt git) :
openclaw plugins install ./path/to/local/mattermost-plugin
Détails : Plugins

Configuration rapide

  1. Assurez-vous que le plugin Mattermost est disponible.
    • Les versions packagées actuelles d’OpenClaw l’intègrent déjà.
    • Les installations anciennes/personnalisées peuvent l’ajouter manuellement avec les commandes ci-dessus.
  2. Créez un compte bot Mattermost et copiez le jeton du bot.
  3. Copiez l’URL de base Mattermost (par ex. https://chat.example.com).
  4. Configurez OpenClaw et démarrez la passerelle.
Configuration minimale :
{
  channels: {
    mattermost: {
      enabled: true,
      botToken: "mm-token",
      baseUrl: "https://chat.example.com",
      dmPolicy: "pairing",
    },
  },
}

Commandes slash natives

Les commandes slash natives sont optionnelles. Lorsqu’elles sont activées, OpenClaw enregistre des commandes slash oc_* via l’API Mattermost et reçoit des POST de rappel sur le serveur HTTP de la passerelle.
{
  channels: {
    mattermost: {
      commands: {
        native: true,
        nativeSkills: true,
        callbackPath: "/api/channels/mattermost/command",
        // À utiliser lorsque Mattermost ne peut pas joindre directement la passerelle (proxy inverse/URL publique).
        callbackUrl: "https://gateway.example.com/api/channels/mattermost/command",
      },
    },
  },
}
Remarques :
  • native: "auto" est désactivé par défaut pour Mattermost. Définissez native: true pour l’activer.
  • Si callbackUrl est omis, OpenClaw en déduit un à partir de l’hôte/port de la passerelle + callbackPath.
  • Pour les configurations multi-comptes, commands peut être défini au niveau supérieur ou sous channels.mattermost.accounts.<id>.commands (les valeurs de compte remplacent les champs de niveau supérieur).
  • Les rappels de commande sont validés avec les jetons par commande renvoyés par Mattermost lorsque OpenClaw enregistre les commandes oc_*.
  • Les rappels slash échouent en mode fermé lorsque l’enregistrement a échoué, que le démarrage a été partiel, ou que le jeton de rappel ne correspond à aucune des commandes enregistrées.
  • Exigence d’accessibilité : le point de terminaison de rappel doit être joignable depuis le serveur Mattermost.
    • Ne définissez pas callbackUrl sur localhost sauf si Mattermost s’exécute sur le même hôte/espace de noms réseau qu’OpenClaw.
    • Ne définissez pas callbackUrl sur votre URL de base Mattermost sauf si cette URL proxifie en inverse /api/channels/mattermost/command vers OpenClaw.
    • Une vérification rapide consiste à exécuter curl https://<gateway-host>/api/channels/mattermost/command ; un GET doit renvoyer 405 Method Not Allowed depuis OpenClaw, pas 404.
  • Exigence de liste d’autorisation de sortie Mattermost :
    • Si votre rappel cible des adresses privées/tailnet/internes, définissez ServiceSettings.AllowedUntrustedInternalConnections dans Mattermost pour inclure l’hôte/domaine de rappel.
    • Utilisez des entrées hôte/domaine, pas des URL complètes.
      • Correct : gateway.tailnet-name.ts.net
      • Incorrect : https://gateway.tailnet-name.ts.net

Variables d’environnement (compte par défaut)

Définissez-les sur l’hôte de la passerelle si vous préférez utiliser des variables d’environnement :
  • MATTERMOST_BOT_TOKEN=...
  • MATTERMOST_URL=https://chat.example.com
Les variables d’environnement s’appliquent uniquement au compte par défaut (default). Les autres comptes doivent utiliser des valeurs de configuration.

Modes de chat

Mattermost répond automatiquement aux messages privés. Le comportement des canaux est contrôlé par chatmode :
  • oncall (par défaut) : répondre uniquement lorsqu’il est @mentionné dans les canaux.
  • onmessage : répondre à chaque message de canal.
  • onchar : répondre lorsqu’un message commence par un préfixe de déclenchement.
Exemple de configuration :
{
  channels: {
    mattermost: {
      chatmode: "onchar",
      oncharPrefixes: [">", "!"],
    },
  },
}
Remarques :
  • onchar répond toujours aux @mentions explicites.
  • channels.mattermost.requireMention est respecté pour les configurations historiques, mais chatmode est préférable.

Fils et sessions

Utilisez channels.mattermost.replyToMode pour contrôler si les réponses de canal et de groupe restent dans le canal principal ou démarrent un fil sous le message déclencheur.
  • off (par défaut) : répondre dans un fil uniquement si le message entrant se trouve déjà dans un fil.
  • first : pour les messages de canal/groupe de niveau supérieur, démarrer un fil sous ce message et router la conversation vers une session limitée à ce fil.
  • all : même comportement que first pour Mattermost aujourd’hui.
  • Les messages privés ignorent ce paramètre et restent hors fil.
Exemple de configuration :
{
  channels: {
    mattermost: {
      replyToMode: "all",
    },
  },
}
Remarques :
  • Les sessions limitées à un fil utilisent l’identifiant du message déclencheur comme racine du fil.
  • first et all sont actuellement équivalents car une fois que Mattermost dispose d’une racine de fil, les segments de suivi et les médias continuent dans ce même fil.

Contrôle d’accès (messages privés)

  • Par défaut : channels.mattermost.dmPolicy = "pairing" (les expéditeurs inconnus reçoivent un code d’appairage).
  • Approuver via :
    • openclaw pairing list mattermost
    • openclaw pairing approve mattermost <CODE>
  • Messages privés publics : channels.mattermost.dmPolicy="open" plus channels.mattermost.allowFrom=["*"].

Canaux (groupes)

  • Par défaut : channels.mattermost.groupPolicy = "allowlist" (avec filtrage par mention).
  • Autorisez des expéditeurs avec channels.mattermost.groupAllowFrom (les identifiants d’utilisateur sont recommandés).
  • Les remplacements de mention par canal se trouvent sous channels.mattermost.groups.<channelId>.requireMention ou channels.mattermost.groups["*"].requireMention pour une valeur par défaut.
  • La correspondance @username est mutable et activée uniquement lorsque channels.mattermost.dangerouslyAllowNameMatching: true.
  • Canaux ouverts : channels.mattermost.groupPolicy="open" (avec filtrage par mention).
  • Remarque d’exécution : si channels.mattermost est totalement absent, l’exécution retombe sur groupPolicy="allowlist" pour les vérifications de groupe (même si channels.defaults.groupPolicy est défini).
Exemple :
{
  channels: {
    mattermost: {
      groupPolicy: "open",
      groups: {
        "*": { requireMention: true },
        "team-channel-id": { requireMention: false },
      },
    },
  },
}

Cibles pour la distribution sortante

Utilisez ces formats de cible avec openclaw message send ou cron/webhooks :
  • channel:<id> pour un canal
  • user:<id> pour un message privé
  • @username pour un message privé (résolu via l’API Mattermost)
Les identifiants opaques nus (comme 64ifufp...) sont ambigus dans Mattermost (ID utilisateur vs ID canal). OpenClaw les résout en priorité utilisateur :
  • Si l’ID existe comme utilisateur (GET /api/v4/users/<id> réussit), OpenClaw envoie un message privé en résolvant le canal direct via /api/v4/channels/direct.
  • Sinon, l’ID est traité comme un ID de canal.
Si vous avez besoin d’un comportement déterministe, utilisez toujours les préfixes explicites (user:<id> / channel:<id>).

Nouvelle tentative pour le canal de message privé

Lorsque OpenClaw envoie vers une cible de message privé Mattermost et doit d’abord résoudre le canal direct, il réessaie par défaut les échecs transitoires de création de canal direct. Utilisez channels.mattermost.dmChannelRetry pour ajuster ce comportement globalement pour le plugin Mattermost, ou channels.mattermost.accounts.<id>.dmChannelRetry pour un seul compte.
{
  channels: {
    mattermost: {
      dmChannelRetry: {
        maxRetries: 3,
        initialDelayMs: 1000,
        maxDelayMs: 10000,
        timeoutMs: 30000,
      },
    },
  },
}
Remarques :
  • Cela s’applique uniquement à la création de canal de message privé (/api/v4/channels/direct), et non à tous les appels d’API Mattermost.
  • Les nouvelles tentatives s’appliquent aux échecs transitoires tels que les limites de débit, les réponses 5xx et les erreurs réseau ou de délai d’attente.
  • Les erreurs client 4xx autres que 429 sont traitées comme permanentes et ne sont pas retentées.

Réactions (outil message)

  • Utilisez message action=react avec channel=mattermost.
  • messageId est l’identifiant du post Mattermost.
  • emoji accepte des noms comme thumbsup ou :+1: (les deux-points sont facultatifs).
  • Définissez remove=true (booléen) pour supprimer une réaction.
  • Les événements d’ajout/suppression de réaction sont transmis comme événements système à la session d’agent routée.
Exemples :
message action=react channel=mattermost target=channel:<channelId> messageId=<postId> emoji=thumbsup
message action=react channel=mattermost target=channel:<channelId> messageId=<postId> emoji=thumbsup remove=true
Configuration :
  • channels.mattermost.actions.reactions : activer/désactiver les actions de réaction (par défaut true).
  • Remplacement par compte : channels.mattermost.accounts.<id>.actions.reactions.

Boutons interactifs (outil message)

Envoyez des messages avec des boutons cliquables. Lorsqu’un utilisateur clique sur un bouton, l’agent reçoit la sélection et peut répondre. Activez les boutons en ajoutant inlineButtons aux capacités du canal :
{
  channels: {
    mattermost: {
      capabilities: ["inlineButtons"],
    },
  },
}
Utilisez message action=send avec un paramètre buttons. Les boutons sont un tableau 2D (lignes de boutons) :
message action=send channel=mattermost target=channel:<channelId> buttons=[[{"text":"Yes","callback_data":"yes"},{"text":"No","callback_data":"no"}]]
Champs des boutons :
  • text (obligatoire) : libellé affiché.
  • callback_data (obligatoire) : valeur renvoyée au clic (utilisée comme ID d’action).
  • style (facultatif) : "default", "primary" ou "danger".
Lorsqu’un utilisateur clique sur un bouton :
  1. Tous les boutons sont remplacés par une ligne de confirmation (par ex. ”✓ Yes selected by @user”).
  2. L’agent reçoit la sélection comme message entrant et répond.
Remarques :
  • Les rappels de bouton utilisent une vérification HMAC-SHA256 (automatique, aucune configuration nécessaire).
  • Mattermost retire les données de rappel de ses réponses API (fonctionnalité de sécurité), donc tous les boutons sont supprimés au clic — une suppression partielle n’est pas possible.
  • Les ID d’action contenant des tirets ou des tirets bas sont nettoyés automatiquement (limitation de routage Mattermost).
Configuration :
  • channels.mattermost.capabilities : tableau de chaînes de capacité. Ajoutez "inlineButtons" pour activer la description de l’outil de boutons dans le prompt système de l’agent.
  • channels.mattermost.interactions.callbackBaseUrl : URL de base externe facultative pour les rappels de bouton (par exemple https://gateway.example.com). Utilisez-la lorsque Mattermost ne peut pas joindre directement la passerelle à son hôte d’écoute.
  • Dans les configurations multi-comptes, vous pouvez également définir le même champ sous channels.mattermost.accounts.<id>.interactions.callbackBaseUrl.
  • Si interactions.callbackBaseUrl est omis, OpenClaw déduit l’URL de rappel à partir de gateway.customBindHost + gateway.port, puis retombe sur http://localhost:<port>.
  • Règle d’accessibilité : l’URL de rappel de bouton doit être joignable depuis le serveur Mattermost. localhost ne fonctionne que lorsque Mattermost et OpenClaw s’exécutent sur le même hôte/espace de noms réseau.
  • Si votre cible de rappel est privée/tailnet/interne, ajoutez son hôte/domaine à ServiceSettings.AllowedUntrustedInternalConnections dans Mattermost.

Intégration API directe (scripts externes)

Les scripts externes et webhooks peuvent publier des boutons directement via l’API REST Mattermost au lieu de passer par l’outil message de l’agent. Utilisez buildButtonAttachments() depuis l’extension lorsque c’est possible ; si vous publiez du JSON brut, suivez ces règles : Structure de charge utile :
{
  channel_id: "<channelId>",
  message: "Choose an option:",
  props: {
    attachments: [
      {
        actions: [
          {
            id: "mybutton01", // alphanumérique uniquement — voir ci-dessous
            type: "button", // obligatoire, sinon les clics sont silencieusement ignorés
            name: "Approve", // libellé affiché
            style: "primary", // facultatif : "default", "primary", "danger"
            integration: {
              url: "https://gateway.example.com/mattermost/interactions/default",
              context: {
                action_id: "mybutton01", // doit correspondre à l’id du bouton (pour la recherche du nom)
                action: "approve",
                // ... tout champ personnalisé ...
                _token: "<hmac>", // voir la section HMAC ci-dessous
              },
            },
          },
        ],
      },
    ],
  },
}
Règles critiques :
  1. Les pièces jointes vont dans props.attachments, pas dans attachments au niveau supérieur (sinon elles sont ignorées silencieusement).
  2. Chaque action nécessite type: "button" — sans cela, les clics sont silencieusement ignorés.
  3. Chaque action nécessite un champ id — Mattermost ignore les actions sans ID.
  4. L’id de l’action doit être strictement alphanumérique ([a-zA-Z0-9]). Les tirets et tirets bas cassent le routage d’action côté serveur de Mattermost (renvoie 404). Supprimez-les avant utilisation.
  5. context.action_id doit correspondre à l’id du bouton pour que le message de confirmation affiche le nom du bouton (par ex. “Approve”) au lieu d’un ID brut.
  6. context.action_id est obligatoire — le gestionnaire d’interaction renvoie 400 sans lui.
Génération du jeton HMAC : La passerelle vérifie les clics de bouton avec HMAC-SHA256. Les scripts externes doivent générer des jetons qui correspondent à la logique de vérification de la passerelle :
  1. Dérivez le secret à partir du jeton du bot : HMAC-SHA256(key="openclaw-mattermost-interactions", data=botToken)
  2. Construisez l’objet context avec tous les champs sauf _token.
  3. Sérialisez avec des clés triées et sans espaces (la passerelle utilise JSON.stringify avec des clés triées, ce qui produit une sortie compacte).
  4. Signez : HMAC-SHA256(key=secret, data=serializedContext)
  5. Ajoutez l’empreinte hexadécimale résultante comme _token dans le context.
Exemple Python :
import hmac, hashlib, json

secret = hmac.new(
    b"openclaw-mattermost-interactions",
    bot_token.encode(), hashlib.sha256
).hexdigest()

ctx = {"action_id": "mybutton01", "action": "approve"}
payload = json.dumps(ctx, sort_keys=True, separators=(",", ":"))
token = hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest()

context = {**ctx, "_token": token}
Pièges HMAC courants :
  • json.dumps de Python ajoute des espaces par défaut ({"key": "val"}). Utilisez separators=(",", ":") pour correspondre à la sortie compacte JavaScript ({"key":"val"}).
  • Signez toujours tous les champs de context (moins _token). La passerelle retire _token puis signe tout ce qui reste. Signer seulement un sous-ensemble provoque un échec silencieux de vérification.
  • Utilisez sort_keys=True — la passerelle trie les clés avant la signature, et Mattermost peut réordonner les champs de context lors du stockage de la charge utile.
  • Dérivez le secret à partir du jeton du bot (déterministe), et non d’octets aléatoires. Le secret doit être identique entre le processus qui crée les boutons et la passerelle qui les vérifie.

Adaptateur d’annuaire

Le plugin Mattermost inclut un adaptateur d’annuaire qui résout les noms de canaux et d’utilisateurs via l’API Mattermost. Cela active les cibles #channel-name et @username dans openclaw message send et dans les distributions cron/webhook. Aucune configuration n’est nécessaire — l’adaptateur utilise le jeton du bot depuis la configuration du compte.

Multi-comptes

Mattermost prend en charge plusieurs comptes sous channels.mattermost.accounts :
{
  channels: {
    mattermost: {
      accounts: {
        default: { name: "Primary", botToken: "mm-token", baseUrl: "https://chat.example.com" },
        alerts: { name: "Alerts", botToken: "mm-token-2", baseUrl: "https://alerts.example.com" },
      },
    },
  },
}

Dépannage

  • Aucune réponse dans les canaux : assurez-vous que le bot est dans le canal et mentionnez-le (oncall), utilisez un préfixe de déclenchement (onchar) ou définissez chatmode: "onmessage".
  • Erreurs d’authentification : vérifiez le jeton du bot, l’URL de base et si le compte est activé.
  • Problèmes multi-comptes : les variables d’environnement s’appliquent uniquement au compte default.
  • Les commandes slash natives renvoient Unauthorized: invalid command token. : OpenClaw n’a pas accepté le jeton de rappel. Causes typiques :
    • l’enregistrement des commandes slash a échoué ou ne s’est achevé que partiellement au démarrage
    • le rappel atteint la mauvaise passerelle/le mauvais compte
    • Mattermost possède encore d’anciennes commandes pointant vers une cible de rappel précédente
    • la passerelle a redémarré sans réactiver les commandes slash
  • Si les commandes slash natives cessent de fonctionner, recherchez dans les journaux mattermost: failed to register slash commands ou mattermost: native slash commands enabled but no commands could be registered.
  • Si callbackUrl est omis et que les journaux avertissent que le rappel a été résolu en http://127.0.0.1:18789/..., cette URL n’est probablement joignable que lorsque Mattermost s’exécute sur le même hôte/espace de noms réseau qu’OpenClaw. Définissez à la place un commands.callbackUrl explicite et joignable de l’extérieur.
  • Les boutons apparaissent comme des cases blanches : l’agent envoie peut-être des données de bouton mal formées. Vérifiez que chaque bouton contient les champs text et callback_data.
  • Les boutons s’affichent mais les clics ne font rien : vérifiez que AllowedUntrustedInternalConnections dans la configuration du serveur Mattermost inclut 127.0.0.1 localhost, et que EnablePostActionIntegration vaut true dans ServiceSettings.
  • Les boutons renvoient 404 au clic : l’id du bouton contient probablement des tirets ou tirets bas. Le routeur d’action de Mattermost casse sur les ID non alphanumériques. Utilisez uniquement [a-zA-Z0-9].
  • Les journaux de la passerelle affichent invalid _token : incompatibilité HMAC. Vérifiez que vous signez tous les champs de context (pas seulement un sous-ensemble), utilisez des clés triées et du JSON compact (sans espaces). Voir la section HMAC ci-dessus.
  • Les journaux de la passerelle affichent missing _token in context : le champ _token n’est pas présent dans le context du bouton. Assurez-vous de l’inclure lors de la construction de la charge utile d’intégration.
  • La confirmation affiche l’ID brut au lieu du nom du bouton : context.action_id ne correspond pas à l’id du bouton. Définissez les deux à la même valeur nettoyée.
  • L’agent ne connaît pas les boutons : ajoutez capabilities: ["inlineButtons"] à la configuration du canal Mattermost.

Lié