Who Am I

matrix.whoami
ActionChat & messagingconnection required

Calls the Matrix API with the connection's credentials.

Report which Matrix account and device the access token belongs to.

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

This node takes no configuration beyond its connection.

Output

One shape.

result

FieldTypeExample
user_id
The account's Matrix id.
string@bot:example.org
device_id
The device the token was issued to.
string—
is_guest
Whether the account is a guest account.
boolean—
{
  "device_id": "",
  "is_guest": false,
  "user_id": "@bot:example.org"
}

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 Who Am I 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.