Join Room
matrix.join_room
ActionChat & messagingconnection required
Calls the Matrix API with the connection's credentials.
Join a room by its id or alias with the connection's account.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Matrix
- Secret shape
- the account access token, or {"access_token": "…"}
- Config it needs
- base_url, user_id, default_room_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
room_id_or_alias The room id (!abc:server) or alias (#ops:server) to join. | string | Yes | — | — | #ops:example.org |
reason Reason recorded on the membership event and shown to the room. | string | No | — | — | — |
via Server names to try the join through, as a JSON array or comma-separated list; needed when the room is known only by id. | array | No | — | array of string | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"room_id_or_alias": "#ops:example.org"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
room_id The id of the room that was joined. | string | — |
{
"room_id": ""
}Notes
- The connection's base_url is the homeserver (e.g. https://matrix.example.org), not the account's server name; the two differ whenever .well-known delegation is in use.
- Rooms are addressed by room id (!abc:server). Resolve a #alias:server with matrix.resolve_room_alias first, or set a default room on the connection.
See Join Room run in a workflow.
In a technical demo we add the Matrix connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.