Matrix

This is a shipped runtime-backed surface: direct sends are implemented, the serve loop is implemented, and the channel can join gateway run or gateway run.

At A Glance

Field	Value
Catalog id	`matrix`
Config key	`matrix`
Implementation status	`runtime_backed`
Transport	`matrix_client_server_sync`
Aliases	none
Default send target kind	`conversation`

Minimal Config

[matrix]
enabled = true
base_url = "https://matrix.example.org"
user_id = "@loongbot:example.org"
access_token_env = "MATRIX_ACCESS_TOKEN"
allowed_room_ids = ["!ops:example.org"]

Smoke Test

loong channels send matrix --target "!ops:example.org" --text "hello from loong"
loong channels serve matrix --once

Command Surface

Operation	Command	Usage or status
direct send	`channels send matrix`	Usage: loong channels send matrix [OPTIONS] —target <TARGET> —text <TEXT>
sync reply loop	`channels serve matrix`	Usage: loong channels serve matrix [OPTIONS]

Required Fields For Send

Requirement	Config paths	Env pointer paths	Default env
channel enabled	`matrix.enabled` `matrix.accounts.<account>.enabled`	none	none
access token	`matrix.access_token` `matrix.accounts.<account>.access_token`	`matrix.access_token_env` `matrix.accounts.<account>.access_token_env`	`MATRIX_ACCESS_TOKEN`
homeserver base url	`matrix.base_url` `matrix.accounts.<account>.base_url`	none	none

Required Fields For Serve

Requirement	Config paths	Env pointer paths	Default env
channel enabled	`matrix.enabled` `matrix.accounts.<account>.enabled`	none	none
access token	`matrix.access_token` `matrix.accounts.<account>.access_token`	`matrix.access_token_env` `matrix.accounts.<account>.access_token_env`	`MATRIX_ACCESS_TOKEN`
homeserver base url	`matrix.base_url` `matrix.accounts.<account>.base_url`	none	none
allowed room ids	`matrix.allowed_room_ids` `matrix.accounts.<account>.allowed_room_ids`	none	none
user id when ignore_self_messages is enabled	`matrix.user_id` `matrix.accounts.<account>.user_id`	none	none

Gateway And Ownership

This surface can run directly through channels serve matrix, or under Gateway And Supervision through gateway run.

Operator Notes

Point base_url at the homeserver, not a Matrix web client URL.
Set user_id when self-message filtering matters for the room topology.

Continue to Channel Guides for the full shipped channel matrix.
Continue to Channels for the conceptual surface model.
Continue to Channel Setup for the shared public setup contract.
Continue to Gateway And Supervision when this surface needs longer-lived runtime ownership.

​Matrix

​At A Glance

​Minimal Config

​Smoke Test

​Command Surface

​Required Fields For Send

​Required Fields For Serve

​Gateway And Ownership

​Operator Notes

​Related Docs