Skip to content

mattermost

mattermost

MattermostChannel — Mattermost REST API adapter.

Classes

MattermostChannel 

MattermostChannel(url: str = '', *, token: str = '', bus: Optional[EventBus] = None)

Bases: BaseChannel

Mattermost channel adapter using the REST API.

PARAMETER DESCRIPTION
url

Mattermost server URL. Falls back to MATTERMOST_URL env var.

TYPE: str DEFAULT: ''

token

Mattermost personal access token or bot token. Falls back to MATTERMOST_TOKEN env var.

TYPE: str DEFAULT: ''

bus

Optional event bus for publishing channel events.

TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/mattermost.py 
37
38
39
40
41
42
43
44
45
46
47
48
def __init__(
    self,
    url: str = "",
    *,
    token: str = "",
    bus: Optional[EventBus] = None,
) -> None:
    self._url = url or os.environ.get("MATTERMOST_URL", "")
    self._token = token or os.environ.get("MATTERMOST_TOKEN", "")
    self._bus = bus
    self._handlers: List[ChannelHandler] = []
    self._status = ChannelStatus.DISCONNECTED
Functions
connect 
connect() -> None

Mark as connected (send-only — no persistent connection).

Source code in src/openjarvis/channels/mattermost.py 
52
53
54
55
56
57
58
def connect(self) -> None:
    """Mark as connected (send-only — no persistent connection)."""
    if not self._url or not self._token:
        logger.warning("No Mattermost URL or token configured")
        self._status = ChannelStatus.ERROR
        return
    self._status = ChannelStatus.CONNECTED
disconnect 
disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/mattermost.py 
60
61
62
def disconnect(self) -> None:
    """Mark as disconnected."""
    self._status = ChannelStatus.DISCONNECTED
send 
send(channel: str, content: str, *, conversation_id: str = '', metadata: Dict[str, Any] | None = None) -> bool

Send a message to a Mattermost channel via the REST API.

Source code in src/openjarvis/channels/mattermost.py 
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send a message to a Mattermost channel via the REST API."""
    if not self._url or not self._token:
        logger.warning("Cannot send: no Mattermost credentials configured")
        return False

    try:
        import httpx

        url = f"{self._url}/api/v4/posts"
        headers = {
            "Authorization": f"Bearer {self._token}",
        }
        payload: Dict[str, Any] = {
            "channel_id": channel,
            "message": content,
        }
        if conversation_id:
            payload["root_id"] = conversation_id

        resp = httpx.post(
            url, json=payload, headers=headers, timeout=10.0,
        )
        if resp.status_code < 300:
            self._publish_sent(channel, content, conversation_id)
            return True
        logger.warning(
            "Mattermost API returned status %d", resp.status_code,
        )
        return False
    except Exception:
        logger.debug("Mattermost send failed", exc_info=True)
        return False
status 
status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/mattermost.py 
107
108
109
def status(self) -> ChannelStatus:
    """Return the current connection status."""
    return self._status
list_channels 
list_channels() -> List[str]

Return available channel identifiers.

Source code in src/openjarvis/channels/mattermost.py 
111
112
113
def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["mattermost"]
on_message 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/mattermost.py 
115
116
117
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)