Matrix

Node: matrix · Full type: n8n-nodes-base.matrix · Version: 1

Credentials

matrixApi (alias: @matrix)

CREDENTIAL @matrix = matrixApi "My Matrix"

Operations

Resource: account

me

No additional parameters.

Resource: event

get

Parameter	Type	Default	Details
roomId	string	""	required
eventId	string	""	required

Resource: media

upload

Parameter	Type	Default	Details
roomId	options	""	required
binaryPropertyName	string	"data"	required
mediaType	options	"image"	required; file, image, audio, video
additionalFields	collection	{}	keys: fileName

Resource: message

create

Parameter	Type	Default	Details
roomId	options	""	required
text	string	""
messageType	options	"m.text"	m.emote, m.notice, m.text
messageFormat	options	"plain"	plain, org.matrix.custom.html
fallbackText	string	""

getAll

Parameter	Type	Default	Details
roomId	options	""	required
returnAll	boolean	false	required
limit	number	100
otherOptions	collection	{}	keys: filter

Resource: room

create

Parameter	Type	Default	Details
roomName	string	""	required
preset	options	"public_chat"	required; private_chat, public_chat
roomAlias	string	""

invite

Parameter	Type	Default	Details
roomId	options	""	required
userId	string	""	required

join

Parameter	Type	Default	Details
roomIdOrAlias	string	""	required

kick

Parameter	Type	Default	Details
roomId	options	""	required
userId	string	""	required
reason	string	""

leave

Parameter	Type	Default	Details
roomId	options	""	required

Resource: roomMember

getAll

Parameter	Type	Default	Details
roomId	options	""	required
filters	collection	{}	keys: notMembership, membership

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
fileName	string	""

otherOptions children:

Parameter	Type	Default	Details
filter	string	""

filters children:

Parameter	Type	Default	Details
notMembership	options	""	`,ban,invite,join,leave`
membership	options	""	`,ban,invite,join,leave`

Example

NODE "matrix" @matrix AS "Matrix" {
  resource: "account",
  operation: "get",
  roomId: {{ $json.roomId }},
  eventId: {{ $json.eventId }},
  binaryPropertyName: {{ $json.binaryPropertyName }}
}