Vai al contenuto principale

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Stato: plugin scaricabile (token bot + eventi WebSocket). Sono supportati canali, gruppi e DM. Mattermost è una piattaforma di messaggistica di team self-hostable; consulta il sito ufficiale su mattermost.com per dettagli sul prodotto e download.

Installazione

Installa Mattermost prima di configurare il canale:
openclaw plugins install @openclaw/mattermost
Dettagli: Plugin

Configurazione rapida

1

Ensure plugin is available

Le versioni pacchettizzate attuali di OpenClaw lo includono già. Le installazioni più vecchie o personalizzate possono aggiungerlo manualmente con i comandi sopra.
2

Create a Mattermost bot

Crea un account bot Mattermost e copia il token bot.
3

Copy the base URL

Copia il base URL di Mattermost (ad esempio, https://chat.example.com).
4

Configure OpenClaw and start the gateway

Configurazione minima:
{
  channels: {
    mattermost: {
      enabled: true,
      botToken: "mm-token",
      baseUrl: "https://chat.example.com",
      dmPolicy: "pairing",
    },
  },
}

Comandi slash nativi

I comandi slash nativi sono facoltativi. Quando sono abilitati, OpenClaw registra i comandi slash oc_* tramite l’API Mattermost e riceve callback POST sul server HTTP del Gateway.
{
  channels: {
    mattermost: {
      commands: {
        native: true,
        nativeSkills: true,
        callbackPath: "/api/channels/mattermost/command",
        // Use when Mattermost cannot reach the gateway directly (reverse proxy/public URL).
        callbackUrl: "https://gateway.example.com/api/channels/mattermost/command",
      },
    },
  },
}
  • native: "auto" è disabilitato per impostazione predefinita per Mattermost. Imposta native: true per abilitarlo.
  • Se callbackUrl viene omesso, OpenClaw ne deriva uno da host/porta del Gateway + callbackPath.
  • Per configurazioni multi-account, commands può essere impostato al livello principale o sotto channels.mattermost.accounts.<id>.commands (i valori dell’account sovrascrivono i campi di livello principale).
  • I callback dei comandi vengono convalidati con i token per comando restituiti da Mattermost quando OpenClaw registra i comandi oc_*.
  • OpenClaw aggiorna la registrazione corrente dei comandi Mattermost prima di accettare ogni callback, così i token obsoleti provenienti da comandi slash eliminati o rigenerati smettono di essere accettati senza riavviare il Gateway.
  • La convalida del callback fallisce in modo chiuso se l’API Mattermost non può confermare che il comando sia ancora corrente; le convalide non riuscite vengono memorizzate brevemente nella cache, le ricerche concorrenti vengono accorpate e gli avvii di nuove ricerche sono limitati per frequenza per comando per contenere la pressione da replay.
  • I callback slash falliscono in modo chiuso quando la registrazione non è riuscita, l’avvio è stato parziale o il token del callback non corrisponde al token registrato del comando risolto (un token valido per un comando non può raggiungere la convalida upstream per un comando diverso).
L’endpoint di callback deve essere raggiungibile dal server Mattermost.
  • Non impostare callbackUrl su localhost a meno che Mattermost non sia in esecuzione sullo stesso host/namespace di rete di OpenClaw.
  • Non impostare callbackUrl sul base URL di Mattermost a meno che quell’URL non esegua reverse proxy di /api/channels/mattermost/command verso OpenClaw.
  • Un controllo rapido è curl https://<gateway-host>/api/channels/mattermost/command; una richiesta GET dovrebbe restituire 405 Method Not Allowed da OpenClaw, non 404.
Se il callback punta a indirizzi privati/tailnet/interni, imposta ServiceSettings.AllowedUntrustedInternalConnections di Mattermost in modo da includere host/dominio del callback.Usa voci host/dominio, non URL completi.
  • Corretto: gateway.tailnet-name.ts.net
  • Errato: https://gateway.tailnet-name.ts.net

Variabili d’ambiente (account predefinito)

Impostale sull’host del Gateway se preferisci usare variabili d’ambiente:
  • MATTERMOST_BOT_TOKEN=...
  • MATTERMOST_URL=https://chat.example.com
Le variabili d’ambiente si applicano solo all’account predefinito (default). Gli altri account devono usare valori di configurazione.MATTERMOST_URL non può essere impostato da un file .env del workspace; consulta File .env del workspace.

Modalità chat

Mattermost risponde automaticamente ai DM. Il comportamento dei canali è controllato da chatmode:
Risponde solo quando viene @menzionato nei canali.
Esempio di configurazione:
{
  channels: {
    mattermost: {
      chatmode: "onchar",
      oncharPrefixes: [">", "!"],
    },
  },
}
Note:
  • onchar risponde comunque alle @menzioni esplicite.
  • channels.mattermost.requireMention è rispettato per le configurazioni legacy, ma chatmode è preferito.

Thread e sessioni

Usa channels.mattermost.replyToMode per controllare se le risposte in canali e gruppi restano nel canale principale o avviano un thread sotto il post che le ha attivate.
  • off (predefinito): risponde in un thread solo quando il post in ingresso è già in un thread.
  • first: per post di livello principale in canali/gruppi, avvia un thread sotto quel post e instrada la conversazione a una sessione con ambito thread.
  • all: stesso comportamento di first per Mattermost oggi.
  • I messaggi diretti ignorano questa impostazione e restano senza thread.
Esempio di configurazione:
{
  channels: {
    mattermost: {
      replyToMode: "all",
    },
  },
}
Note:
  • Le sessioni con ambito thread usano l’id del post che ha attivato la conversazione come radice del thread.
  • first e all sono attualmente equivalenti perché, una volta che Mattermost ha una radice di thread, i blocchi successivi e i media continuano nello stesso thread.

Controllo accessi (DM)

  • Predefinito: channels.mattermost.dmPolicy = "pairing" (i mittenti sconosciuti ricevono un codice di abbinamento).
  • Approva tramite:
    • openclaw pairing list mattermost
    • openclaw pairing approve mattermost <CODE>
  • DM pubblici: channels.mattermost.dmPolicy="open" più channels.mattermost.allowFrom=["*"].
  • channels.mattermost.allowFrom accetta voci accessGroup:<name>. Consulta Gruppi di accesso.

Canali (gruppi)

  • Predefinito: channels.mattermost.groupPolicy = "allowlist" (vincolato alla menzione).
  • Inserisci i mittenti nell’allowlist con channels.mattermost.groupAllowFrom (ID utente consigliati).
  • channels.mattermost.groupAllowFrom accetta voci accessGroup:<name>. Consulta Gruppi di accesso.
  • Le sostituzioni per menzione per canale si trovano sotto channels.mattermost.groups.<channelId>.requireMention o channels.mattermost.groups["*"].requireMention per un valore predefinito.
  • La corrispondenza @username è mutabile ed è abilitata solo quando channels.mattermost.dangerouslyAllowNameMatching: true.
  • Canali aperti: channels.mattermost.groupPolicy="open" (vincolato alla menzione).
  • Nota runtime: se channels.mattermost è completamente assente, il runtime ripiega su groupPolicy="allowlist" per i controlli di gruppo (anche se channels.defaults.groupPolicy è impostato).
Esempio:
{
  channels: {
    mattermost: {
      groupPolicy: "open",
      groups: {
        "*": { requireMention: true },
        "team-channel-id": { requireMention: false },
      },
    },
  },
}

Target per la consegna in uscita

Usa questi formati di target con openclaw message send o cron/webhook:
  • channel:<id> per un canale
  • user:<id> per un DM
  • @username per un DM (risolto tramite l’API Mattermost)
Gli ID opachi senza prefisso (come 64ifufp...) sono ambigui in Mattermost (ID utente rispetto a ID canale).OpenClaw li risolve prima come utenti:
  • Se l’ID esiste come utente (GET /api/v4/users/<id> riesce), OpenClaw invia un DM risolvendo il canale diretto tramite /api/v4/channels/direct.
  • Altrimenti l’ID viene trattato come ID canale.
Se hai bisogno di un comportamento deterministico, usa sempre i prefissi espliciti (user:<id> / channel:<id>).

Riprova del canale DM

Quando OpenClaw invia a un target DM Mattermost e deve prima risolvere il canale diretto, per impostazione predefinita ritenta gli errori transitori di creazione del canale diretto. Usa channels.mattermost.dmChannelRetry per regolare questo comportamento globalmente per il plugin Mattermost, oppure channels.mattermost.accounts.<id>.dmChannelRetry per un account.
{
  channels: {
    mattermost: {
      dmChannelRetry: {
        maxRetries: 3,
        initialDelayMs: 1000,
        maxDelayMs: 10000,
        timeoutMs: 30000,
      },
    },
  },
}
Note:
  • Questo si applica solo alla creazione del canale DM (/api/v4/channels/direct), non a ogni chiamata API Mattermost.
  • I tentativi si applicano a errori transitori come limiti di frequenza, risposte 5xx ed errori di rete o timeout.
  • Gli errori client 4xx diversi da 429 sono trattati come permanenti e non vengono ritentati.

Streaming dell’anteprima

Mattermost trasmette pensiero, attività degli strumenti e testo parziale della risposta in un unico post di anteprima bozza che viene finalizzato sul posto quando la risposta finale può essere inviata in sicurezza. L’anteprima si aggiorna sullo stesso id post invece di intasare il canale con messaggi per ogni blocco. I finali media/errore annullano le modifiche dell’anteprima in sospeso e usano la consegna normale invece di inviare un post di anteprima usa e getta. Abilita tramite channels.mattermost.streaming:
{
  channels: {
    mattermost: {
      streaming: "partial", // off | partial | block | progress
    },
  },
}
  • partial è la scelta abituale: un post di anteprima che viene modificato man mano che la risposta cresce, poi finalizzato con la risposta completa.
  • block usa blocchi bozza in stile append all’interno del post di anteprima.
  • progress mostra un’anteprima di stato durante la generazione e pubblica solo la risposta finale al completamento.
  • off disabilita lo streaming dell’anteprima.
  • Se lo stream non può essere finalizzato sul posto (ad esempio il post è stato eliminato durante lo stream), OpenClaw ripiega sull’invio di un nuovo post finale, così la risposta non viene mai persa.
  • I payload di solo ragionamento vengono soppressi dai post del canale, incluso il testo che arriva come blockquote > Reasoning:. Imposta /reasoning on per vedere il pensiero in altre superfici; il post finale Mattermost mantiene solo la risposta.
  • Consulta Streaming per la matrice di mappatura dei canali.

Reazioni (strumento message)

  • Usa message action=react con channel=mattermost.
  • messageId è l’id del post Mattermost.
  • emoji accetta nomi come thumbsup o :+1: (i due punti sono facoltativi).
  • Imposta remove=true (booleano) per rimuovere una reazione.
  • Gli eventi di aggiunta/rimozione reazione vengono inoltrati come eventi di sistema alla sessione agente instradata.
Esempi:
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
Configurazione:
  • channels.mattermost.actions.reactions: abilita/disabilita le azioni di reazione (predefinito true).
  • Sostituzione per account: channels.mattermost.accounts.<id>.actions.reactions.

Pulsanti interattivi (strumento message)

Invia messaggi con pulsanti cliccabili. Quando un utente fa clic su un pulsante, l’agente riceve la selezione e può rispondere. Abilita i pulsanti aggiungendo inlineButtons alle capacità del canale:
{
  channels: {
    mattermost: {
      capabilities: ["inlineButtons"],
    },
  },
}
Usa message action=send con un parametro buttons. I pulsanti sono un array 2D (righe di pulsanti):
message action=send channel=mattermost target=channel:<channelId> buttons=[[{"text":"Yes","callback_data":"yes"},{"text":"No","callback_data":"no"}]]
Campi dei pulsanti:
text
string
obbligatorio
Etichetta visualizzata.
callback_data
string
obbligatorio
Valore inviato al clic (usato come ID dell’azione).
style
"default" | "primary" | "danger"
Stile del pulsante.
Quando un utente fa clic su un pulsante:
1

Pulsanti sostituiti con conferma

Tutti i pulsanti vengono sostituiti con una riga di conferma (ad esempio, ”✓ selezionato da @user”).
2

L'agente riceve la selezione

L’agente riceve la selezione come messaggio in ingresso e risponde.
  • I callback dei pulsanti usano la verifica HMAC-SHA256 (automatica, non serve configurazione).
  • Mattermost rimuove i dati di callback dalle sue risposte API (funzione di sicurezza), quindi tutti i pulsanti vengono rimossi al clic - la rimozione parziale non è possibile.
  • Gli ID azione contenenti trattini o underscore vengono sanificati automaticamente (limitazione del routing di Mattermost).
  • channels.mattermost.capabilities: array di stringhe di capability. Aggiungi "inlineButtons" per abilitare la descrizione dello strumento dei pulsanti nel prompt di sistema dell’agente.
  • channels.mattermost.interactions.callbackBaseUrl: URL base esterno opzionale per i callback dei pulsanti (ad esempio https://gateway.example.com). Usalo quando Mattermost non può raggiungere il gateway direttamente al suo host di bind.
  • Nelle configurazioni multi-account, puoi impostare lo stesso campo anche sotto channels.mattermost.accounts.<id>.interactions.callbackBaseUrl.
  • Se interactions.callbackBaseUrl viene omesso, OpenClaw deriva l’URL di callback da gateway.customBindHost + gateway.port, poi ripiega su http://localhost:<port>.
  • Regola di raggiungibilità: l’URL di callback del pulsante deve essere raggiungibile dal server Mattermost. localhost funziona solo quando Mattermost e OpenClaw vengono eseguiti sullo stesso host/namespace di rete.
  • Se la destinazione del callback è privata/tailnet/interna, aggiungi il suo host/dominio a ServiceSettings.AllowedUntrustedInternalConnections di Mattermost.

Integrazione API diretta (script esterni)

Script esterni e webhook possono pubblicare pulsanti direttamente tramite l’API REST di Mattermost invece di passare dallo strumento message dell’agente. Usa buildButtonAttachments() dal plugin quando possibile; se pubblichi JSON grezzo, segui queste regole: Struttura del payload:
{
  channel_id: "<channelId>",
  message: "Choose an option:",
  props: {
    attachments: [
      {
        actions: [
          {
            id: "mybutton01", // alphanumeric only - see below
            type: "button", // required, or clicks are silently ignored
            name: "Approve", // display label
            style: "primary", // optional: "default", "primary", "danger"
            integration: {
              url: "https://gateway.example.com/mattermost/interactions/default",
              context: {
                action_id: "mybutton01", // must match button id (for name lookup)
                action: "approve",
                // ... any custom fields ...
                _token: "<hmac>", // see HMAC section below
              },
            },
          },
        ],
      },
    ],
  },
}
Regole critiche
  1. Gli attachment vanno in props.attachments, non in attachments al livello superiore (ignorato silenziosamente).
  2. Ogni azione richiede type: "button" - senza questo, i clic vengono ignorati silenziosamente.
  3. Ogni azione richiede un campo id - Mattermost ignora le azioni senza ID.
  4. L’id dell’azione deve essere solo alfanumerico ([a-zA-Z0-9]). Trattini e underscore rompono il routing delle azioni lato server di Mattermost (restituisce 404). Rimuovili prima dell’uso.
  5. context.action_id deve corrispondere all’id del pulsante, così il messaggio di conferma mostra il nome del pulsante (ad esempio, “Approve”) invece di un ID grezzo.
  6. context.action_id è obbligatorio - il gestore dell’interazione restituisce 400 senza di esso.
Generazione del token HMAC Il gateway verifica i clic sui pulsanti con HMAC-SHA256. Gli script esterni devono generare token che corrispondano alla logica di verifica del gateway:
1

Deriva il segreto dal token del bot

HMAC-SHA256(key="openclaw-mattermost-interactions", data=botToken)
2

Crea l'oggetto context

Crea l’oggetto context con tutti i campi eccetto _token.
3

Serializza con chiavi ordinate

Serializza con chiavi ordinate e senza spazi (il gateway usa JSON.stringify con chiavi ordinate, che produce output compatto).
4

Firma il payload

HMAC-SHA256(key=secret, data=serializedContext)
5

Aggiungi il token

Aggiungi il digest esadecimale risultante come _token nel context.
Esempio 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}
  • json.dumps di Python aggiunge spazi per impostazione predefinita ({"key": "val"}). Usa separators=(",", ":") per corrispondere all’output compatto di JavaScript ({"key":"val"}).
  • Firma sempre tutti i campi del context (meno _token). Il gateway rimuove _token e poi firma tutto ciò che rimane. Firmare un sottoinsieme causa un errore di verifica silenzioso.
  • Usa sort_keys=True - il gateway ordina le chiavi prima di firmare, e Mattermost può riordinare i campi del context quando memorizza il payload.
  • Deriva il segreto dal token del bot (deterministico), non da byte casuali. Il segreto deve essere lo stesso tra il processo che crea i pulsanti e il gateway che verifica.

Adattatore directory

Il plugin Mattermost include un adattatore directory che risolve i nomi di canali e utenti tramite l’API Mattermost. Questo abilita le destinazioni #channel-name e @username in openclaw message send e nelle consegne cron/webhook. Non serve alcuna configurazione - l’adattatore usa il token del bot dalla configurazione dell’account.

Multi-account

Mattermost supporta più account sotto 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" },
      },
    },
  },
}

Risoluzione dei problemi

Assicurati che il bot sia nel canale e menzionalo (oncall), usa un prefisso di attivazione (onchar), oppure imposta chatmode: "onmessage".
  • Controlla il token del bot, l’URL base e se l’account è abilitato.
  • Problemi multi-account: le variabili d’ambiente si applicano solo all’account default.
  • Unauthorized: invalid command token.: OpenClaw non ha accettato il token di callback. Cause tipiche:
    • la registrazione del comando slash non è riuscita o è stata completata solo parzialmente all’avvio
    • il callback sta raggiungendo il gateway/account sbagliato
    • Mattermost ha ancora vecchi comandi che puntano a una destinazione di callback precedente
    • il gateway è stato riavviato senza riattivare i comandi slash
  • Se i comandi slash nativi smettono di funzionare, controlla i log per mattermost: failed to register slash commands o mattermost: native slash commands enabled but no commands could be registered.
  • Se callbackUrl viene omesso e i log avvisano che il callback è stato risolto in http://127.0.0.1:18789/..., quell’URL è probabilmente raggiungibile solo quando Mattermost viene eseguito sullo stesso host/namespace di rete di OpenClaw. Imposta invece un commands.callbackUrl esplicito raggiungibile dall’esterno.
  • I pulsanti appaiono come riquadri bianchi: l’agente potrebbe inviare dati dei pulsanti malformati. Controlla che ogni pulsante abbia entrambi i campi text e callback_data.
  • I pulsanti vengono renderizzati ma i clic non producono effetti: verifica che AllowedUntrustedInternalConnections nella configurazione del server Mattermost includa 127.0.0.1 localhost e che EnablePostActionIntegration sia true in ServiceSettings.
  • I pulsanti restituiscono 404 al clic: l’id del pulsante probabilmente contiene trattini o underscore. Il router delle azioni di Mattermost si rompe con ID non alfanumerici. Usa solo [a-zA-Z0-9].
  • I log del Gateway mostrano invalid _token: mancata corrispondenza HMAC. Controlla di firmare tutti i campi del context (non un sottoinsieme), di usare chiavi ordinate e JSON compatto (senza spazi). Vedi la sezione HMAC sopra.
  • I log del Gateway mostrano missing _token in context: il campo _token non è nel context del pulsante. Assicurati che sia incluso quando crei il payload di integrazione.
  • La conferma mostra l’ID grezzo invece del nome del pulsante: context.action_id non corrisponde all’id del pulsante. Imposta entrambi sullo stesso valore sanificato.
  • L’agente non sa dei pulsanti: aggiungi capabilities: ["inlineButtons"] alla configurazione del canale Mattermost.

Correlati