matrix.json•11 kB
{
"nodeType": "n8n-nodes-base.matrix",
"displayName": "Matrix",
"description": "Consume Matrix API",
"version": 1,
"properties": [
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "me",
"description": "Get current user's account information",
"options": [
{
"name": "Me",
"value": "me",
"description": "Get current user's account information"
}
],
"displayOptions": {
"show": {
"resource": [
"account"
]
}
}
},
{
"name": "roomId",
"displayName": "Room ID",
"type": "string",
"default": "",
"description": "The room related to the event",
"placeholder": "!123abc:matrix.org",
"required": true,
"displayOptions": {
"show": {
"operation": [
"get"
],
"resource": [
"event"
]
}
}
},
{
"name": "eventId",
"displayName": "Event ID",
"type": "string",
"default": "",
"description": "The room related to the event",
"placeholder": "$1234abcd:matrix.org",
"required": true,
"displayOptions": {
"show": {
"operation": [
"get"
],
"resource": [
"event"
]
}
}
},
{
"name": "binaryPropertyName",
"displayName": "Input Binary Field",
"type": "string",
"default": "data",
"required": true,
"displayOptions": {
"show": {
"resource": [
"media"
],
"operation": [
"upload"
]
}
}
},
{
"name": "mediaType",
"displayName": "Media Type",
"type": "options",
"default": "image",
"description": "General file",
"placeholder": "mxc://matrix.org/uploaded-media-uri",
"required": true,
"options": [
{
"name": "File",
"value": "file",
"description": "General file"
},
{
"name": "Image",
"value": "image",
"description": "Image media type"
},
{
"name": "Audio",
"value": "audio",
"description": "Audio media type"
},
{
"name": "Video",
"value": "video",
"description": "Video media type"
}
],
"displayOptions": {
"show": {
"resource": [
"media"
],
"operation": [
"upload"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Name of the file being uploaded",
"placeholder": "Add Field",
"options": [
{
"name": "fileName",
"displayName": "File Name",
"type": "string",
"default": "",
"description": "Name of the file being uploaded"
}
],
"displayOptions": {
"show": {
"resource": [
"media"
],
"operation": [
"upload"
]
}
}
},
{
"name": "text",
"displayName": "Text",
"type": "string",
"default": "",
"description": "The text to send",
"placeholder": "Hello from n8n!",
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"message"
]
}
}
},
{
"name": "messageType",
"displayName": "Message Type",
"type": "options",
"default": "m.text",
"description": "Perform an action (similar to /me in IRC)",
"options": [
{
"name": "Emote",
"value": "m.emote",
"description": "Perform an action (similar to /me in IRC)"
},
{
"name": "Notice",
"value": "m.notice",
"description": "Send a notice"
},
{
"name": "Text",
"value": "m.text",
"description": "Send a text message"
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"message"
]
}
}
},
{
"name": "messageFormat",
"displayName": "Message Format",
"type": "options",
"default": "plain",
"description": "Text only",
"options": [
{
"name": "Plain Text",
"value": "plain",
"description": "Text only"
},
{
"name": "HTML",
"value": "org.matrix.custom.html",
"description": "HTML-formatted text"
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"message"
]
}
}
},
{
"name": "fallbackText",
"displayName": "Fallback Text",
"type": "string",
"default": "",
"description": "A plain text message to display in case the HTML cannot be rendered by the Matrix client",
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"create"
],
"messageFormat": [
"org.matrix.custom.html"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 100,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 500
},
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "otherOptions",
"displayName": "Other Options",
"type": "collection",
"default": {},
"description": "A JSON RoomEventFilter to filter returned events with. More information can be found on this <a href=\"https://matrix.org/docs/spec/client_server/r0.6.0\">page</a>.",
"placeholder": "Add option",
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "roomName",
"displayName": "Room Name",
"type": "string",
"default": "",
"placeholder": "My new room",
"required": true,
"displayOptions": {
"show": {
"resource": [
"room"
],
"operation": [
"create"
]
}
}
},
{
"name": "preset",
"displayName": "Preset",
"type": "options",
"default": "public_chat",
"description": "Open and public chat",
"placeholder": "My new room",
"required": true,
"options": [
{
"name": "Private Chat",
"value": "private_chat"
},
{
"name": "Public Chat",
"value": "public_chat",
"description": "Open and public chat"
}
],
"displayOptions": {
"show": {
"resource": [
"room"
],
"operation": [
"create"
]
}
}
},
{
"name": "roomAlias",
"displayName": "Room Alias",
"type": "string",
"default": "",
"placeholder": "coolest-room-around",
"displayOptions": {
"show": {
"resource": [
"room"
],
"operation": [
"create"
]
}
}
},
{
"name": "roomIdOrAlias",
"displayName": "Room ID or Alias",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"room"
],
"operation": [
"join"
]
}
}
},
{
"name": "userId",
"displayName": "User ID",
"type": "string",
"default": "",
"description": "The fully qualified user ID of the invitee",
"placeholder": "@cheeky_monkey:matrix.org",
"required": true,
"displayOptions": {
"show": {
"resource": [
"room"
],
"operation": [
"invite"
]
}
}
},
{
"name": "reason",
"displayName": "Reason",
"type": "string",
"default": "",
"description": "Reason for kick",
"placeholder": "Telling unfunny jokes",
"displayOptions": {
"show": {
"resource": [
"room"
],
"operation": [
"kick"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "Filtering options",
"placeholder": "Add filter",
"displayOptions": {
"show": {
"resource": [
"roomMember"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "message",
"options": [
{
"name": "Account",
"value": "account"
},
{
"name": "Event",
"value": "event"
},
{
"name": "Media",
"value": "media"
},
{
"name": "Message",
"value": "message"
},
{
"name": "Room",
"value": "room"
},
{
"name": "Room Member",
"value": "roomMember"
}
]
}
],
"credentialsConfig": [
{
"name": "matrixApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}