Create Room Alias
matrix.create_room_alias
ActionChat & messagingconnection required
Calls the Matrix API with the connection's credentials.
Point a room alias at a room on this homeserver.
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
2 fields, 2 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_alias The alias to create, e.g. #release-2026:example.org. | string | Yes | — | — | — |
room_id The room id, e.g. !AbCdEf:example.org — resolve a #alias:server with matrix.resolve_room_alias first. | string | Yes | — | — | !AbCdEf:example.org |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"room_id": "!AbCdEf:example.org"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
created True once the mapping exists. | boolean | — |
room_alias The alias that was created. | string | — |
room_id The room it points at. | string | — |
{
"created": false,
"room_alias": "",
"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.
- An alias that already exists is refused with 409; delete it first if you mean to repoint it.
See Create Room Alias 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.