Skip to content

MatrixBinding

Defined in: types.ts:106

Matrix transport binding. Lives under agents.<name>.matrix: in zooid.yaml. The block name (matrix) is the transport-kind discriminator: transports[transport].type must equal "matrix".

Properties

transport

transport: string

Defined in: types.ts:111

Ref into ZooidConfig.transports. Resolved transport must have type: ‘matrix’.

Default

if exactly one matrix transport is declared, that transport's key

user_id

user_id: string

Defined in: types.ts:117

Full Matrix user ID for this agent’s bot, e.g. @architect:example.com.

Default

@<agent name>:<server> — server is derived from the resolved transport’s user_namespace


display_name?

optional display_name?: string

Defined in: types.ts:122

Optional human-readable display name. Written to the agent’s Matrix profile on bootstrap. Falls back to the user_id localpart when absent.


rooms

rooms: RoomBinding[]

Defined in: types.ts:124

Rooms this agent watches. Each entry carries the alias/ID and an optional declared PL.


trigger

trigger: "mention" | "any"

Defined in: types.ts:130

Routing rule. mention requires the bot to be tagged; any triggers on every message.

Default

'mention'