Matrix (matrix)

Category: io | Form: | Symbol: Mx

Connect flows to Matrix for receiving and sending messages

Unified Matrix connector — receives messages and sends them depending on wiring topology. When the trigger port is exposed (unwired input), acts as a listener via Matrix Application Service API. When the request port is driven (wired from another element), acts as a sender via the Matrix Client-Server API. Configure spec.homeserver_url (e.g., “https://matrix.org”), spec.access_token_ref with a bot access token, and spec.user_id with the bot’s Matrix user ID (e.g., @bot:server.org). Matrix is federated and self-hostable — homeserver URL varies per deployment. For inbound: spec.room_types and spec.allowed_rooms filter which rooms trigger events. For outbound: spec.default_room_id sets the fallback room. The rooms operation lists joined rooms with names (best-effort name fetch via /state/m.room.name). Common mistake: missing homeserver_url, access_token_ref, or user_id — all required.

Guide

Connect flows to Matrix for receiving and sending messages

What It Does

Matrix is an IO connector that bridges your Triform flows with Matrix rooms. It uses the Matrix Client-Server API to receive incoming messages and events, and send messages to rooms. Matrix is a decentralized, open-standard protocol for real-time communication.

Element Definition

Property	Value
Type	matrix
Category	io
Form	atom

Key Properties

Field	Type	Default	Description
homeserver_url	string	—	Matrix homeserver URL (e.g., https://matrix.org)
access_token_ref	string	—	Reference to secret containing Matrix access token
room_ids	array	—	Room IDs to join and listen in
event_types	array	[m.room.message]	Matrix event types to listen for

Usage

1. Create a Matrix bot account on your homeserver
2. Create a secret element for the access token
3. Configure the Matrix element with homeserver URL and room IDs
4. Wire to an automation or action to process incoming messages

Relationships

• Attaches to: rate-limit, auth-policy
• Uses: variable

Capabilities

• matrix-appservice: Receive events via Matrix Application Service API
• room-filtering: Filter events by room type and allowlist
• matrix-send: Send messages to Matrix rooms via Client-Server API
• threading: Reply in Matrix threads via thread_event_id

Properties

Property	Type	Default	Description
homeserver_url	string	—	Matrix homeserver URL (e.g., https://matrix.org)
access_token_ref	string	—	Reference to secret element containing bot access token
user_id	string	—	Bot’s Matrix user ID (e.g., @bot:server.org)
room_types	array	["direct","group"]	Matrix room types to listen for (when receiving)
allowed_rooms	array	—	Optional room ID allowlist (empty = all rooms)
default_room_id	string	—	Default room ID to send messages to (when sending)
message_format	string	"markdown"	Default message format: plain text, Markdown, or HTML (when sending)

Operations

activity

Get /ops/activity | Auth: Read

Get activity events for this element

Scope depends on element capabilities: individual elements query by element_id, project-form elements with activity-scope-members include member activities, circle-level elements with activity-scope-all query the entire circle. Gracefully returns empty list if activities table is missing (old circles).

attachments

Get /ops/attachments | Auth: Read

List all modifiers and resources attached to this element

Returns both modifiers (policy enforcement) and resources (data injection) with is_modifier flag to distinguish. Items in the generated MODIFIER_TYPES list are modifiers; everything else is a resource. Includes cascade_policy and version pin info.

batch_stats

Get /ops/batch_stats | Auth: Read

Get per-element statistics for all children of this element

Returns per-child stats plus an aggregate. Most meaningful on compound or manifest form elements (repositories, circles, projects); atoms have no children so the result is an empty children array with a zeroed aggregate. Uses efficient GROUP BY SQL. Weighted averages for eval scores.

compose

Post /ops/compose | Auth: Execute

Batch add and remove modifiers on this element in a single call

Declarative composition: add modifiers by ref path (slug or path@version) and remove by attachment ID, all in one atomic call on the target element. Each ‘add’ entry resolves the source element, validates topology, attaches with optional priority and cascade policy. Each ‘remove’ entry deletes the attachment row. Returns a summary of what was added and removed. Example: compose({ add: [{ref: “my-prompt”}, {ref: “rate-limit/api@v2”, priority: 50}], remove: [{attachment_id: “uuid”}] })

context

Get /ops/context | Auth: Read

Get connected elements (graph traversal)

Graph traversal showing all connected elements with their relationship type (contains, contained_by, references, referenced_by, attaches, etc.). Use ?depth=N to control traversal depth (default 1) and ?types=actor,data to filter by element types.

create

Post /ops/create | Auth: Write

Create child element

POST to the parent path — element_type goes in the request body, NOT the URL. Both element_type and slug are required and must be non-empty. Name is derived from slug if omitted. Writes to both Git and PostgreSQL. All elements are stored flat under the circle — no intermediate library wrapper rows.

delete

Delete /ops/delete | Auth: Admin

Delete element (soft delete)

Soft delete — sets state to ‘deleted’ but retains the record. Cannot delete elements that have children (has_no_bond precondition) or active runs. Requires admin auth and confirmation.

disable

Post /ops/disable | Auth: Admin

Disable element (hides and prevents use)

Idempotent — safe to call on already-disabled elements. Optionally pass a reason string. Disabled elements cannot be invoked or executed. Inverse of enable.

enable

Post /ops/enable | Auth: Admin

Enable element (makes usable and visible)

Idempotent — safe to call on already-enabled elements. Transitions element to ready/enabled state. Cannot enable deleted elements. Inverse of disable.

export_bundle

Get /ops/export/bundle | Auth: Read

Export element as downloadable git bundle

On non-root-namespace elements, returns a binary git bundle. On root-namespace (circle) elements, dispatch hands off to the circle’s own export_bundle op, which returns a multi-element JSON envelope with one base64 bundle per child element — this is intentional, not an error.

get

Get /ops/get | Auth: Read

Get element details

Element is already resolved by the routing layer — this returns the cached element, not a fresh DB query. Use the path /api/{circle}/{slug} to address elements.

import_bundle

Post /ops/import/bundle | Auth: Write

Import git bundle into element

Accepts a base64-encoded git bundle in the JSON bundle_base64 field. Use overwrite=true to replace existing elements with same slug (default skips duplicates). Imported elements get new UUIDs. Returns counts of imported/skipped elements and any errors.

intention

Get /ops/intention | Auth: Read

Get element intention with full inheritance chain

Returns three levels: direct (this element’s intention), inherited (from category and root), and resolved (final merged intention). Useful for understanding an element’s purpose in context of its hierarchy.

promote

Post /ops/promote | Auth: Admin

Promote element configuration to a target environment

Only for manifest-form elements (projects). Environments advance: dev → demo → live. dev→demo requires member+ role, demo→live requires admin. Freezes member versions at promotion time (creates snapshot). Persists environment config to spec.environments.

readme

Get /ops/readme | Auth: Read

Get element README.md content

Reads README.md from the element’s git repository. Returns empty content (not an error) if no README exists. Always returns markdown format.

readme_update

Post /ops/readme_update | Auth: Write

Update element README.md content

Creates or overwrites README.md in the element’s git repo. Commits to the draft branch. Content must be provided as a markdown string.

receive

Post /ops/receive | Auth: None

Receive incoming external traffic

Entry point for external traffic reaching this IO element. Declared auth: none to bypass platform auth — element-level auth is enforced by IoReceiveExecutor before dispatching into the flow graph. The flow/app that wires this element as an entry point determines what happens next.

remove-modifier

Post /ops/remove-modifier | Auth: Execute

Remove an attached modifier from this element by attachment ID

Removes a modifier/resource attachment by its row ID. The ID comes from the attachments or context API. This is the reverse of attach — called on the target element, not the source.

restore

Post /ops/restore | Auth: Admin

Restore element to a specific version

Automatically snapshots the current state before restoring (creates a ‘Before restore to vN’ version entry). Writes restored spec to git as .triform/spec.yaml. Git failures warn but don’t fail the operation — DB state is authoritative. Cannot restore deleted elements.

rooms

Get /ops/rooms | Auth: Read

List Matrix rooms the bot is a member of

Calls Matrix Client-Server API /joined_rooms and fetches room names via /state/m.room.name. Room name fetching is best-effort — fails silently if the name state event can’t be retrieved (in which case name is an empty string). Requires spec.homeserver_url and spec.access_token_ref. Returns room_id and name per room. Use room_id values in spec.default_room_id or send requests.

schema

Get /ops/schema | Auth: Read

Get element input/output schema (MCP tools/list compatible)

Returns type-level port schemas from the TypeRegistry — not instance-specific overrides. Includes direction (input/output), required flag, and JSON schema per port. Useful for understanding what data an element accepts and produces.

send

Post /ops/send | Auth: Write

Send a message to a Matrix room

Sends an m.room.message to a Matrix room via PUT /_matrix/client/v3/rooms/{roomId}/send. Requires spec.homeserver_url and spec.access_token_ref. The room_id input is OPTIONAL when spec.default_room_id is set — if omitted, the executor falls back to the spec-configured default. If neither is provided, the op returns InvalidInput with an explanatory error pointing at both remedies. The message text comes from body (preferred) or message (legacy alias). At least one must be non-empty or the op returns InvalidInput. Use the rooms op to discover room_id values to set in spec.default_room_id or pass per-call. Returns the Matrix event_id of the sent message.

source

Get /ops/source | Auth: Read

Get any file’s content from the element’s git repository

Reads an arbitrary file from the element’s CAS-backed git tree by its relative path. Same store as readme, just generalized. Path safety: rejects .. traversal, leading /, and null bytes. Use this to view main.py for action elements, asset files for SPAs, etc. Returns empty content (not an error) if the file doesn’t exist.

source_branches

Get /ops/source/branches | Auth: Read

List Source branches for this element

Returns the standard draft/demo/live Source branches, their current commits, and promotion relationships. Use GET /api/{element_path}/ops/source/branches.

source_promote

Post /ops/source/promote | Auth: Write

Promote Source branch forward

Promotes draft to demo or demo to live through the generated element op path. Direct Git pushes to demo/live are blocked by Source policy.

source_repair

Post /ops/source/repair | Auth: Write

Inspect or repair the element Source index

Runs Source repair through the element operation path. Defaults to dry_run=true; set dry_run=false only after reviewing a dry-run report.

source_status

Get /ops/source/status | Auth: Read

Get Source control status for this element

Returns the branch-aware clone URL, checkout commands, current draft commit, child source-link count, portable export summary, Source health, warnings, and auth hints for the addressed element. Use the element-first path: GET /api/{element_path}/ops/source/status.

source_validate

Post /ops/source/validate | Auth: Read

Validate Source branch contents

Validates a Source branch before accepting local Git workflow changes or promotion. Defaults to branch=draft and rejects runtime data, generated output, secret material, and unreadable CAS refs.

stats

Get /ops/stats | Auth: Read

Get aggregate statistics for this element

Health status is computed: error if errors_per_day > 5 or success_rate < 0.8, warning if errors_per_day > 0 or success_rate < 0.95. Firing alerts escalate health to error/warning. Default period is ‘day’. Returns runs_per_day, success_rate, avg_duration_ms, and more.

test_connection

Post /ops/test_connection | Auth: Read

Test the Matrix access token configuration

Validates that spec.access_token_ref resolves and that the Matrix homeserver accepts it by calling /_matrix/client/v3/account/whoami. Returns connected: true and the user_id on success. Use to verify credentials before sending messages.

tree

Get /ops/tree | Auth: Read

Get the element’s position in the graph — ancestors, children, references, and subtree statistics

Uses per-circle ElementGraph cache for O(1) lookups. Returns ancestors (containment chain), children (direct), members (references), referenced_by (reverse refs), attachments, and subtree stats. Default depth is 3, max is 10. Pass ?include_metadata=true for name/state on each node.

update

Patch /ops/update | Auth: Write

Update element

Partial update — send only the fields you want to change. spec, name, and intention are all independently optional. spec MUST be a JSON object when present; deep-merged into the existing spec by default. Empty {"spec":{}} preserves existing spec content but still records a new version (no-op for content, not for version state). To clear/replace the entire spec wholesale send {"spec":{...},"deep":false}. List-typed spec fields use replace semantics (the patch list replaces the existing list, no array merging). Coordinates Git + DB writes. Slug cannot be changed after creation.

update_meta

Patch /ops/update_meta | Auth: Write

Update element metadata (lightweight merge — does NOT bump version or snapshot spec)

Shallow JSONB merge into element.meta. Top-level keys in the provided value replace existing meta values; other keys are preserved. Used for UI metadata like canvas positions, panel state, viewer preferences. Wire-shape op_name is update_meta (distinct from update) so SSE subscribers + the cache auto-invalidator can distinguish lightweight metadata changes from spec edits without inspecting the payload. The MutatingElementStore wrapper stamps this op_name on the lifecycle event emitted by update_element_meta storage calls.

version

Get /ops/version | Auth: Read

Get current version or full history

Returns current version by default. Pass ?history=true for full version history (up to ?limit=N, default 50). Versions are backed by the element_versions table. Every spec update creates a new version entry.

Error Codes

Code	Class	Retryable	Description
MATRIX_AUTH_FAILED	auth	no	Matrix access token invalid or expired
MATRIX_ROOM_DENIED	auth	no	Room not in allowlist
MATRIX_SEND_FAILED	internal	yes	Failed to send message to Matrix
MATRIX_ROOM_NOT_FOUND	validation	no	Target room not found or bot not a member