# nodes

node_type: nodes-base.microsoftTeams
package_name: n8n-nodes-base
display_name: Microsoft Teams
description: Consume Microsoft Teams API
category: input
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "microsoftTeamsOAuth2Api",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Microsoft Teams node documentation
  description: Learn how to use the Microsoft Teams node in n8n. Follow technical documentation to integrate Microsoft Teams node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Microsoft Teams node

  Use the Microsoft Teams node to automate work in Microsoft Teams, and integrate Microsoft Teams with other applications. n8n has built-in support for a wide range of Microsoft Teams features, including creating and deleting, channels, messages, and tasks. 

  On this page, you'll find a list of operations the Microsoft Teams node supports and links to more resources.

  /// note | Credentials
  Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication.
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Channel
      * Create
      * Delete
      * Get
      * Get Many
      * Update
  * Channel Message
      * Create
      * Get Many
  * Chat Message
  	* Create
  	* Get
  	* Get Many
  	* Send and Wait for Response
  * Task
      * Create
      * Delete
      * Get
      * Get Many
      * Update

  --8<-- "_snippets/integrations/builtin/send-and-wait-operation.md"

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'microsoft-teams') ]]

  ## Related resources

  Refer to [Microsoft Teams' API documentation](https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0){:target=_blank .external-link} for more information about the service.

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "channel",
      "options": [
        {
          "name": "Channel",
          "value": "channel"
        },
        {
          "name": "Channel Message",
          "value": "channelMessage"
        },
        {
          "name": "Chat Message",
          "value": "chatMessage"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a channel",
          "action": "Create channel"
        },
        {
          "name": "Delete",
          "value": "deleteChannel",
          "description": "Delete a channel",
          "action": "Delete channel"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a channel",
          "action": "Get channel"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many channels",
          "action": "Get many channels"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a channel",
          "action": "Update channel"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "New Channel Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the new channel you want to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "The description of the channel",
          "typeOptions": {
            "rows": 2
          }
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "options": [
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Standard",
              "value": "standard"
            }
          ],
          "default": "standard",
          "description": "Standard: Accessible to everyone on the team. Private: Accessible only to a specific group of people within the team."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "deleteChannel"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the channel from the list, by URL, or by ID (the ID is the \"threadId\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "deleteChannel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "teamId.value"
        ]
      }
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the channel from the list, by URL, or by ID (the ID is the \"threadId\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "teamId.value"
        ]
      }
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "channel"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the channel from the list, by URL, or by ID (the ID is the \"threadId\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "teamId.value"
        ]
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the channel",
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "The description of the channel",
          "typeOptions": {
            "rows": 2
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a message in a channel",
          "action": "Create message"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many messages from a channel",
          "action": "Get many messages"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the channel from the list, by URL, or by ID (the ID is the \"threadId\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "teamId.value"
        ]
      }
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "options",
      "default": "text",
      "description": "Whether the message is plain text or HTML",
      "options": [
        {
          "name": "Text",
          "value": "text"
        },
        {
          "name": "HTML",
          "value": "html"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The content of the message to be sent",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "rows": 2
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Link to Workflow",
          "name": "includeLinkToWorkflow",
          "type": "boolean",
          "default": true,
          "description": "Whether to append a link to this workflow at the end of the message. This is helpful if you have many workflows sending messages."
        },
        {
          "displayName": "Reply to ID",
          "name": "makeReply",
          "type": "string",
          "default": "",
          "placeholder": "e.g. 1673348720590",
          "description": "An optional ID of the message you want to reply to. The message ID is the number before \"?tenantId\" in the message URL."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the team from the list, by URL, or by ID (the ID is the \"groupId\" parameter in the URL you get from \"Get a link to the team\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the channel from the list, by URL, or by ID (the ID is the \"threadId\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "teamId.value"
        ]
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "channelMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a message in a chat",
          "action": "Create chat message"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a message from a chat",
          "action": "Get chat message"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many messages from a chat",
          "action": "Get many chat messages"
        },
        {
          "name": "Send and Wait for Response",
          "value": "sendAndWait",
          "description": "Send a message and wait for response",
          "action": "Send message and wait for response"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Chat",
      "name": "chatId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the chat from the list, by URL, or by ID (find the chat ID after \"conversations/\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "options",
      "default": "text",
      "description": "Whether the message is plain text or HTML",
      "options": [
        {
          "name": "Text",
          "value": "text"
        },
        {
          "name": "HTML",
          "value": "html"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The content of the message to be sent",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "rows": 2
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "description": "Other options to set",
      "options": [
        {
          "displayName": "Include Link to Workflow",
          "name": "includeLinkToWorkflow",
          "type": "boolean",
          "default": true,
          "description": "Whether to append a link to this workflow at the end of the message. This is helpful if you have many workflows sending messages."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Chat",
      "name": "chatId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the chat from the list, by URL, or by ID (find the chat ID after \"conversations/\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Message ID",
      "name": "messageId",
      "type": "string",
      "default": "",
      "description": "The ID of the message to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Chat",
      "name": "chatId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the chat from the list, by URL, or by ID (find the chat ID after \"conversations/\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Chat",
      "name": "chatId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the chat from the list, by URL, or by ID (find the chat ID after \"conversations/\" in the URL)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "rows": 4
      }
    },
    {
      "displayName": "Response Type",
      "name": "responseType",
      "type": "options",
      "default": "approval",
      "options": [
        {
          "name": "Approval",
          "value": "approval",
          "description": "User can approve/disapprove from within the message"
        },
        {
          "name": "Free Text",
          "value": "freeText",
          "description": "User can submit a response via a form"
        },
        {
          "name": "Custom Form",
          "value": "customForm",
          "description": "User can submit a response via a custom form"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Define Form",
      "name": "defineForm",
      "type": "options",
      "default": "fields",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "fields"
        },
        {
          "name": "Using JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "customForm"
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Fields",
      "name": "jsonOutput",
      "type": "json",
      "default": "[\n   {\n      \"fieldLabel\":\"Name\",\n      \"placeholder\":\"enter you name\",\n      \"requiredField\":true\n   },\n   {\n      \"fieldLabel\":\"Age\",\n      \"fieldType\":\"number\",\n      \"placeholder\":\"enter your age\"\n   },\n   {\n      \"fieldLabel\":\"Email\",\n      \"fieldType\":\"email\",\n      \"requiredField\":true\n   }\n]",
      "displayOptions": {
        "show": {
          "defineForm": [
            "json"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Form Elements",
      "name": "formFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Element Type",
              "name": "fieldType",
              "type": "options",
              "default": "text",
              "description": "The type of field to add to the form",
              "options": [
                {
                  "name": "Custom HTML",
                  "value": "html"
                },
                {
                  "name": "Date",
                  "value": "date"
                },
                {
                  "name": "Dropdown List",
                  "value": "dropdown"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "File",
                  "value": "file"
                },
                {
                  "name": "Hidden Field",
                  "value": "hiddenField"
                },
                {
                  "name": "Number",
                  "value": "number"
                },
                {
                  "name": "Password",
                  "value": "password"
                },
                {
                  "name": "Text",
                  "value": "text"
                },
                {
                  "name": "Textarea",
                  "value": "textarea"
                }
              ],
              "required": true
            },
            {
              "displayName": "Element Name",
              "name": "elementName",
              "type": "string",
              "default": "",
              "placeholder": "e.g. content-section",
              "description": "Optional field. It can be used to include the html in the output.",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Placeholder",
              "name": "placeholder",
              "description": "Sample text to display inside the field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "dropdown",
                    "date",
                    "file",
                    "html",
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "description": "Input value can be set here or will be passed as a query parameter via Field Name if no value is set",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Options",
              "name": "fieldOptions",
              "placeholder": "Add Field Option",
              "description": "List of options that can be selected from the dropdown",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Option",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Multiple Choice",
              "name": "multiselect",
              "type": "boolean",
              "default": false,
              "description": "Whether to allow the user to select multiple options from the dropdown list",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ]
                }
              }
            },
            {
              "displayName": "HTML",
              "name": "html",
              "typeOptions": {
                "editor": "htmlEditor"
              },
              "type": "string",
              "noDataExpression": true,
              "default": "<!-- Your custom HTML here --->\n\n\n",
              "description": "HTML elements to display on the form page",
              "hint": "Does not accept <code>&lt;script&gt;</code>, <code>&lt;style&gt;</code> or <code>&lt;input&gt;</code> tags",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Files",
              "name": "multipleFiles",
              "type": "boolean",
              "default": true,
              "description": "Whether to allow the user to select multiple files from the file input or just one",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "Accepted File Types",
              "name": "acceptFileTypes",
              "type": "string",
              "default": "",
              "description": "Comma-separated list of allowed file extensions",
              "hint": "Leave empty to allow all file types",
              "placeholder": "e.g. .jpg, .png",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "The displayed date is formatted based on the locale of the user's browser",
              "name": "formatDate",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Required Field",
              "name": "requiredField",
              "type": "boolean",
              "default": false,
              "description": "Whether to require the user to enter a value for this field before submitting the form",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html",
                    "hiddenField"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "defineForm": [
            "fields"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Approval Options",
      "name": "approvalOptions",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Type of Approval",
              "name": "approvalType",
              "type": "options",
              "placeholder": "Add option",
              "default": "single",
              "options": [
                {
                  "name": "Approve Only",
                  "value": "single"
                },
                {
                  "name": "Approve and Disapprove",
                  "value": "double"
                }
              ]
            },
            {
              "displayName": "Approve Button Label",
              "name": "approveLabel",
              "type": "string",
              "default": "✓ Approve",
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "single",
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Disapprove Button Label",
              "name": "disapproveLabel",
              "type": "string",
              "default": "✗ Decline",
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "double"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "approval"
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Limit Wait Time",
          "name": "limitWaitTime",
          "type": "fixedCollection",
          "description": "Whether the workflow will automatically resume execution after the specified limit type",
          "default": {
            "values": {
              "limitType": "afterTimeInterval",
              "resumeAmount": 45,
              "resumeUnit": "minutes"
            }
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Limit Type",
                  "name": "limitType",
                  "type": "options",
                  "default": "afterTimeInterval",
                  "description": "Sets the condition for the execution to resume. Can be a specified date or after some time.",
                  "options": [
                    {
                      "name": "After Time Interval",
                      "description": "Waits for a certain amount of time",
                      "value": "afterTimeInterval"
                    },
                    {
                      "name": "At Specified Time",
                      "description": "Waits until the set date and time to continue",
                      "value": "atSpecifiedTime"
                    }
                  ]
                },
                {
                  "displayName": "Amount",
                  "name": "resumeAmount",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "numberPrecision": 2
                  },
                  "default": 1,
                  "description": "The time to wait"
                },
                {
                  "displayName": "Unit",
                  "name": "resumeUnit",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Minutes",
                      "value": "minutes"
                    },
                    {
                      "name": "Hours",
                      "value": "hours"
                    },
                    {
                      "name": "Days",
                      "value": "days"
                    }
                  ],
                  "default": "hours",
                  "description": "Unit of the interval value"
                },
                {
                  "displayName": "Max Date and Time",
                  "name": "maxDateAndTime",
                  "type": "dateTime",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "atSpecifiedTime"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Continue execution after the specified date and time"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase \"This message was sent automatically with n8n\" to the end of the message"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "approval"
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Message Button Label",
          "name": "messageButtonLabel",
          "type": "string",
          "default": "Respond"
        },
        {
          "displayName": "Response Form Title",
          "name": "responseFormTitle",
          "description": "Title of the form that the user can access to provide their response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Response Form Description",
          "name": "responseFormDescription",
          "description": "Description of the form that the user can access to provide their response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Response Form Button Label",
          "name": "responseFormButtonLabel",
          "type": "string",
          "default": "Submit"
        },
        {
          "displayName": "Limit Wait Time",
          "name": "limitWaitTime",
          "type": "fixedCollection",
          "description": "Whether the workflow will automatically resume execution after the specified limit type",
          "default": {
            "values": {
              "limitType": "afterTimeInterval",
              "resumeAmount": 45,
              "resumeUnit": "minutes"
            }
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Limit Type",
                  "name": "limitType",
                  "type": "options",
                  "default": "afterTimeInterval",
                  "description": "Sets the condition for the execution to resume. Can be a specified date or after some time.",
                  "options": [
                    {
                      "name": "After Time Interval",
                      "description": "Waits for a certain amount of time",
                      "value": "afterTimeInterval"
                    },
                    {
                      "name": "At Specified Time",
                      "description": "Waits until the set date and time to continue",
                      "value": "atSpecifiedTime"
                    }
                  ]
                },
                {
                  "displayName": "Amount",
                  "name": "resumeAmount",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "numberPrecision": 2
                  },
                  "default": 1,
                  "description": "The time to wait"
                },
                {
                  "displayName": "Unit",
                  "name": "resumeUnit",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Minutes",
                      "value": "minutes"
                    },
                    {
                      "name": "Hours",
                      "value": "hours"
                    },
                    {
                      "name": "Days",
                      "value": "days"
                    }
                  ],
                  "default": "hours",
                  "description": "Unit of the interval value"
                },
                {
                  "displayName": "Max Date and Time",
                  "name": "maxDateAndTime",
                  "type": "dateTime",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "atSpecifiedTime"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Continue execution after the specified date and time"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase \"This message was sent automatically with n8n\" to the end of the message"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "freeText",
            "customForm"
          ],
          "resource": [
            "chatMessage"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a task",
          "action": "Create task"
        },
        {
          "name": "Delete",
          "value": "deleteTask",
          "description": "Delete a task",
          "action": "Delete task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a task",
          "action": "Get task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tasks",
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a task",
          "action": "Update task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Team",
      "name": "groupId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "groupSource"
        ]
      }
    },
    {
      "displayName": "Plan",
      "name": "planId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The plan for the task to belong to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "groupId.value"
        ]
      }
    },
    {
      "displayName": "Bucket",
      "name": "bucketId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The bucket for the task to belong to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "planId.value"
        ]
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the task",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "typeOptions": {
            "loadOptionsDependsOn": [
              "groupId.balue"
            ]
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select a Member...",
              "typeOptions": {
                "searchListMethod": "getMembers",
                "searchable": true
              }
            },
            {
              "displayName": "By ID",
              "name": "id",
              "type": "string",
              "placeholder": "7e2f1174-e8ee-4859-b8b1-a8d1cc63d276",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": "^([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})[ \t]*",
                    "errorMessage": "Not a valid Microsoft Teams Team ID"
                  }
                }
              ],
              "extractValue": {
                "type": "regex",
                "regex": "^([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})"
              }
            }
          ],
          "description": "Who the task should be assigned to"
        },
        {
          "displayName": "Due Date Time",
          "name": "dueDateTime",
          "type": "string",
          "validateType": "dateTime",
          "default": "",
          "description": "Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time."
        },
        {
          "displayName": "Percent Complete",
          "name": "percentComplete",
          "type": "number",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 100
          },
          "default": 0,
          "placeholder": "e.g. 75",
          "description": "Percentage of task completion. When set to 100, the task is considered completed."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "The ID of the task to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "deleteTask"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "The ID of the task to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Tasks For",
      "name": "tasksFor",
      "type": "options",
      "default": "member",
      "description": "Whether to retrieve the tasks for a user or for a plan",
      "options": [
        {
          "name": "Group Member",
          "value": "member",
          "description": "Tasks assigned to group member"
        },
        {
          "name": "Plan",
          "value": "plan",
          "description": "Tasks in group plan"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Team",
      "name": "groupId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "groupSource"
        ]
      }
    },
    {
      "displayName": "Plan",
      "name": "planId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The plan for the task to belong to",
      "required": true,
      "displayOptions": {
        "show": {
          "tasksFor": [
            "plan"
          ],
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "groupId.value"
        ]
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "The ID of the task to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "typeOptions": {
            "loadOptionsDependsOn": [
              "updateFields.groupId.value"
            ]
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select a Member...",
              "typeOptions": {
                "searchListMethod": "getMembers",
                "searchable": true
              }
            },
            {
              "displayName": "By ID",
              "name": "id",
              "type": "string",
              "placeholder": "7e2f1174-e8ee-4859-b8b1-a8d1cc63d276",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": "^([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})[ \t]*",
                    "errorMessage": "Not a valid Microsoft Teams Team ID"
                  }
                }
              ],
              "extractValue": {
                "type": "regex",
                "regex": "^([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})"
              }
            }
          ],
          "description": "Who the task should be assigned to",
          "hint": "Select 'Team' from options first",
          "required": false
        },
        {
          "displayName": "Bucket",
          "name": "bucketId",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "required": false,
          "typeOptions": {
            "loadOptionsDependsOn": [
              "updateFields.planId.value"
            ]
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select a Bucket...",
              "typeOptions": {
                "searchListMethod": "getBuckets",
                "searchable": true
              }
            },
            {
              "displayName": "By ID",
              "name": "id",
              "type": "string",
              "placeholder": "rl1HYb0cUEiHPc7zgB_KWWUAA7Of"
            }
          ],
          "description": "The bucket for the task to belong to"
        },
        {
          "displayName": "Due Date Time",
          "name": "dueDateTime",
          "type": "string",
          "validateType": "dateTime",
          "default": "",
          "description": "Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time."
        },
        {
          "displayName": "Team",
          "name": "groupId",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "required": false,
          "typeOptions": {
            "loadOptionsDependsOn": [
              "/groupSource"
            ]
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select a Team...",
              "typeOptions": {
                "searchListMethod": "getGroups",
                "searchable": true
              }
            },
            {
              "displayName": "By ID",
              "name": "id",
              "type": "string",
              "placeholder": "12f0ca7d-b77f-4c4e-93d2-5cbdb4f464c6",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": "^([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})[ \t]*",
                    "errorMessage": "Not a valid Microsoft Teams Team ID"
                  }
                }
              ],
              "extractValue": {
                "type": "regex",
                "regex": "^([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})"
              }
            }
          ]
        },
        {
          "displayName": "Percent Complete",
          "name": "percentComplete",
          "type": "number",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 100
          },
          "default": 0,
          "placeholder": "e.g. 75",
          "description": "Percentage of task completion. When set to 100, the task is considered completed."
        },
        {
          "displayName": "Plan",
          "name": "planId",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "required": false,
          "typeOptions": {
            "loadOptionsDependsOn": [
              "updateFields.groupId.value"
            ]
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select a Plan...",
              "typeOptions": {
                "searchListMethod": "getPlans",
                "searchable": true
              }
            },
            {
              "displayName": "By ID",
              "name": "id",
              "type": "string",
              "placeholder": "rl1HYb0cUEiHPc7zgB_KWWUAA7Of"
            }
          ],
          "description": "The plan for the task to belong to",
          "hint": "Select 'Team' from options first"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "placeholder": "e.g. my task",
          "description": "Title of the task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a channel"
    },
    {
      "operation": "deleteChannel",
      "name": "Delete",
      "description": "Delete a channel"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a channel"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many channels"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a channel"
    }
  ]


node_type: nodes-base.microsoftTeamsTrigger
package_name: n8n-nodes-base
display_name: Microsoft Teams Trigger
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "microsoftTeamsOAuth2Api",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
description:
  Triggers workflows in n8n based on events from Microsoft Teams, such as new messages or team updates, using specified configurations.

documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Microsoft Teams Trigger node documentation
  description: Learn how to use the Microsoft Teams Trigger node in n8n. Follow technical documentation to integrate Microsoft Teams Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Microsoft Teams Trigger node

  Use the Microsoft Teams Trigger node to respond to events in [Microsoft Teams](https://www.microsoft.com/en-us/microsoft-teams/group-chat-software) and integrate Microsoft Teams with other applications.

  On this page, you'll find a list of events the Microsoft Teams Trigger node can respond to and links to more resources.

  ///  note  | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/microsoft.md).
  ///

  ## Events

  * **New Channel**
  * **New Channel Message**
  * **New Chat**
  * **New Chat Message**
  * **New Team Member**

  ## Related resources

  n8n provides an app node for Microsoft Teams. You can find the node docs [here](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftteams.md).

  <!-- add a link to the node page on n8n's website. For example: https://n8n.io/integrations/356-gmail/ -->
  View [example workflows and related content](https://n8n.io/integrations/microsoft-teams-trigger/) on n8n's website.

  <!-- add a link to the service's documentation. This should usually go direct to the API docs -->
  Refer to the [Microsoft Teams documentation](https://learn.microsoft.com/en-us/graph/api/resources/teams-api-overview?view=graph-rest-1.0) for details about their API.

properties_schema:
  [
    {
      "displayName": "Trigger On",
      "name": "event",
      "type": "options",
      "default": "newChannelMessage",
      "description": "Select the event to trigger the workflow",
      "options": [
        {
          "name": "New Channel",
          "value": "newChannel",
          "description": "A new channel is created"
        },
        {
          "name": "New Channel Message",
          "value": "newChannelMessage",
          "description": "A message is posted to a channel"
        },
        {
          "name": "New Chat",
          "value": "newChat",
          "description": "A new chat is created"
        },
        {
          "name": "New Chat Message",
          "value": "newChatMessage",
          "description": "A message is posted to a chat"
        },
        {
          "name": "New Team Member",
          "value": "newTeamMember",
          "description": "A new member is added to a team"
        }
      ]
    },
    {
      "displayName": "Watch All Teams",
      "name": "watchAllTeams",
      "type": "boolean",
      "default": false,
      "description": "Whether to watch for the event in all the available teams",
      "displayOptions": {
        "show": {
          "event": [
            "newChannel",
            "newChannelMessage",
            "newTeamMember"
          ]
        }
      }
    },
    {
      "displayName": "Team",
      "name": "teamId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select a team from the list, enter an ID or a URL",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "newChannel",
            "newChannelMessage",
            "newTeamMember"
          ],
          "watchAllTeams": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Watch All Channels",
      "name": "watchAllChannels",
      "type": "boolean",
      "default": false,
      "description": "Whether to watch for the event in all the available channels",
      "displayOptions": {
        "show": {
          "event": [
            "newChannelMessage"
          ],
          "watchAllTeams": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select a channel from the list, enter an ID or a URL",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "newChannelMessage"
          ],
          "watchAllTeams": [
            false
          ],
          "watchAllChannels": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Watch All Chats",
      "name": "watchAllChats",
      "type": "boolean",
      "default": false,
      "description": "Whether to watch for the event in all the available chats",
      "displayOptions": {
        "show": {
          "event": [
            "newChatMessage"
          ]
        }
      }
    },
    {
      "displayName": "Chat",
      "name": "chatId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select a chat from the list, enter an ID or a URL",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "newChatMessage"
          ],
          "watchAllChats": [
            false
          ]
        }
      }
    }
  ]


node_type: nodes-base.microsoftToDo
package_name: n8n-nodes-base
display_name: Microsoft To Do
description: Consume Microsoft To Do API.
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "microsoftToDoOAuth2Api",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Microsoft To Do node documentation
  description: Learn how to use the Microsoft To Do node in n8n. Follow technical documentation to integrate Microsoft To Do node into your workflows.
  contentType: [integration, reference]
  ---

  # Microsoft To Do node

  Use the Microsoft To Do node to automate work in Microsoft To Do, and integrate Microsoft To Do with other applications. n8n has built-in support for a wide range of Microsoft To Do features, including creating, updating, deleting, and getting linked resources, lists, and tasks. 

  On this page, you'll find a list of operations the Microsoft To Do node supports and links to more resources.

  /// note | Credentials
  Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication.
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Linked Resource
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * List
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Task
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'microsoft-to-do') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "task",
      "options": [
        {
          "name": "Linked Resource",
          "value": "linkedResource"
        },
        {
          "name": "List",
          "value": "list"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a linked resource"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a linked resource"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a linked resource"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many linked resources"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a linked resource"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "linkedResource"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Task List Name or ID",
      "name": "taskListId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "delete",
            "get",
            "getAll",
            "update"
          ],
          "resource": [
            "linkedResource"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTaskLists"
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "delete",
            "get",
            "getAll",
            "update"
          ],
          "resource": [
            "linkedResource"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "Field indicating title of the linked entity",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "linkedResource"
          ]
        }
      }
    },
    {
      "displayName": "Application Name",
      "name": "applicationName",
      "type": "string",
      "default": "",
      "description": "App name of the source that is sending the linked entity",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "linkedResource"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "default": "",
          "description": "ID of the object that is associated with this task on the third-party/partner system"
        },
        {
          "displayName": "Web URL",
          "name": "webUrl",
          "type": "string",
          "default": "",
          "description": "Deeplink to the linked entity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "linkedResource"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Linked Resource ID",
      "name": "linkedResourceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "linkedResource"
          ],
          "operation": [
            "delete",
            "get",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "linkedResource"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "linkedResource"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Application Name",
          "name": "applicationName",
          "type": "string",
          "default": "",
          "description": "App name of the source that is sending the linked entity"
        },
        {
          "displayName": "Name",
          "name": "displayName",
          "type": "string",
          "default": "",
          "description": "Field indicating title of the linked entity"
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "default": "",
          "description": "ID of the object that is associated with this task on the third-party/partner system"
        },
        {
          "displayName": "Web URL",
          "name": "webUrl",
          "type": "string",
          "default": "",
          "description": "Deeplink to the linked entity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "linkedResource"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "taskListId",
      "type": "options",
      "default": "",
      "description": "The identifier of the list, unique in the user's mailbox. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTaskLists"
      }
    },
    {
      "displayName": "Subject",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "A brief description of the task",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Content",
          "name": "content",
          "type": "string",
          "default": "",
          "description": "The content of the task"
        },
        {
          "displayName": "Due",
          "name": "dueDateTime",
          "type": "dateTime",
          "default": "",
          "description": "The date in the specified time zone that the task is to be finished"
        },
        {
          "displayName": "Reminder",
          "name": "reminderDateTime",
          "type": "dateTime",
          "default": "",
          "description": "The date in the specified time zone that the task is to be reminded"
        },
        {
          "displayName": "Importance",
          "name": "importance",
          "type": "options",
          "options": [
            {
              "name": "Low",
              "value": "low"
            },
            {
              "name": "Normal",
              "value": "normal"
            },
            {
              "name": "High",
              "value": "high"
            }
          ],
          "default": "normal",
          "description": "The importance of the task"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Not Started",
              "value": "notStarted"
            },
            {
              "name": "In Progress",
              "value": "inProgress"
            },
            {
              "name": "Completed",
              "value": "completed"
            },
            {
              "name": "Waiting On Others",
              "value": "waitingOnOthers"
            },
            {
              "name": "Deferred",
              "value": "deferred"
            }
          ],
          "default": "notStarted",
          "description": "Indicates the state or progress of the task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "taskListId",
      "type": "options",
      "default": "",
      "description": "The identifier of the list, unique in the user's mailbox. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete",
            "get",
            "getAll",
            "update"
          ],
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTaskLists"
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete",
            "get",
            "update"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Content",
          "name": "content",
          "type": "string",
          "default": "",
          "description": "The content of the task"
        },
        {
          "displayName": "Due Date Time",
          "name": "dueDateTime",
          "type": "dateTime",
          "default": "",
          "description": "The date in the specified time zone that the task is to be finished"
        },
        {
          "displayName": "Reminder",
          "name": "reminderDateTime",
          "type": "dateTime",
          "default": "",
          "description": "The date in the specified time zone that the task is to be reminded"
        },
        {
          "displayName": "Importance",
          "name": "importance",
          "type": "options",
          "options": [
            {
              "name": "Low",
              "value": "low"
            },
            {
              "name": "Normal",
              "value": "normal"
            },
            {
              "name": "High",
              "value": "high"
            }
          ],
          "default": "normal",
          "description": "The importance of the task"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Not Started",
              "value": "notStarted"
            },
            {
              "name": "In Progress",
              "value": "inProgress"
            },
            {
              "name": "Completed",
              "value": "completed"
            },
            {
              "name": "Waiting On Others",
              "value": "waitingOnOthers"
            },
            {
              "name": "Deferred",
              "value": "deferred"
            }
          ],
          "default": "notStarted",
          "description": "Indicates the state or progress of the task"
        },
        {
          "displayName": "Subject",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "A brief description of the task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a list"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many lists"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "List display name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The identifier of the list, unique in the user's mailbox",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete",
            "get",
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "New List Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "List display name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    }
  ]

operations:
[cell repeats an earlier one in this file: 283 characters]


node_type: nodes-base.mindee
package_name: n8n-nodes-base
display_name: Mindee
description: Consume Mindee API
category: input
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "predict",
  "name": "Predict"
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mindee node documentation
  description: Learn how to use the Mindee node in n8n. Follow technical documentation to integrate Mindee node into your workflows.
  contentType: [integration, reference]
  ---

  # Mindee node

  Use the Mindee node to automate work in Mindee, and integrate Mindee with other applications. n8n has built-in support for a wide range of Mindee features, including predicting invoices. 

  On this page, you'll find a list of operations the Mindee node supports and links to more resources.

  /// note | Credentials
  Refer to [Mindee credentials](/integrations/builtin/credentials/mindee.md) for guidance on setting up authentication. 
  ///

  ## Operations

  - **Invoice**
      - Predict
  - **Receipt**
      - Predict

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mindee') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": 1,
      "description": "Which Mindee API Version to use",
      "options": [
        {
          "name": "1",
          "value": 1
        },
        {
          "name": "3",
          "value": 3
        },
        {
          "name": "4",
          "value": 4
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": 3,
      "description": "Which Mindee API Version to use",
      "options": [
        {
          "name": "1",
          "value": 1
        },
        {
          "name": "3",
          "value": 3
        },
        {
          "name": "4",
          "value": 4
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ]
        }
      }
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": 4,
      "description": "Which Mindee API Version to use",
      "options": [
        {
          "name": "1",
          "value": 1
        },
        {
          "name": "3",
          "value": 3
        },
        {
          "name": "4",
          "value": 4
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            3
          ]
        }
      }
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "receipt",
      "options": [
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Receipt",
          "value": "receipt"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "predict",
      "options": [
        {
          "name": "Predict",
          "value": "predict"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "predict"
          ],
          "resource": [
            "receipt",
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether to return the data exactly in the way it got received from the API"
    }
  ]

credentials_required:
  [
    {
      "name": "mindeeReceiptApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "receipt"
          ]
        }
      }
    },
    {
      "name": "mindeeInvoiceApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      }
    }
  ]


node_type: nodes-base.misp
package_name: n8n-nodes-base
display_name: MISP
description: Consume the MISP API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mispApi",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MISP node documentation
  description: Learn how to use the MISP node in n8n. Follow technical documentation to integrate MISP node into your workflows.
  contentType: [integration, reference]
  ---

  # MISP node

  Use the MISP node to automate work in MISP, and integrate MISP with other applications. n8n has built-in support for a wide range of MISP features, including creating, updating, deleting and getting events, feeds, and organizations. 

  On this page, you'll find a list of operations the MISP node supports and links to more resources.

  /// note | Credentials
  Refer to [MISP credentials](/integrations/builtin/credentials/misp.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Attribute
      * Create
      * Delete
      * Get
      * Get All
  	* Search
      * Update
  * Event
      * Create
      * Delete
      * Get
      * Get All
      * Publish
  	* Search
      * Unpublish
      * Update
  * Event Tag
      * Add
      * Remove
  * Feed
      * Create
      * Disable
      * Enable
      * Get
      * Get All
      * Update
  * Galaxy
      * Delete
      * Get
      * Get All
  * Noticelist
      * Get
      * Get All
  * Object
  	* Search
  * Organisation
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Tag
      * Create
      * Delete
      * Get All
      * Update
  * User
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Warninglist
      * Get
      * Get All

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'misp') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "attribute",
      "options": [
        {
          "name": "Attribute",
          "value": "attribute"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Event Tag",
          "value": "eventTag"
        },
        {
          "name": "Feed",
          "value": "feed"
        },
        {
          "name": "Galaxy",
          "value": "galaxy"
        },
        {
          "name": "Noticelist",
          "value": "noticelist"
        },
        {
          "name": "Object",
          "value": "object"
        },
        {
          "name": "Organisation",
          "value": "organisation"
        },
        {
          "name": "Tag",
          "value": "tag"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "Warninglist",
          "value": "warninglist"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an attribute"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an attribute"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an attribute"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many attributes"
        },
        {
          "name": "Search",
          "value": "search",
          "action": "Get a filtered list of attributes"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an attribute"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Event UUID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID of the event to attach the attribute to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "text",
      "options": [
        {
          "name": "Text",
          "value": "text"
        },
        {
          "name": "URL",
          "value": "url"
        },
        {
          "name": "Comment",
          "value": "comment"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Distribution",
          "name": "distribution",
          "type": "options",
          "default": 0,
          "description": "Who will be able to see this event once published",
          "options": [
            {
              "name": "All Communities",
              "value": 3
            },
            {
              "name": "Connected Communities",
              "value": 2
            },
            {
              "name": "Inherit Event",
              "value": 5
            },
            {
              "name": "Sharing Group",
              "value": 4
            },
            {
              "name": "This Community Only",
              "value": 1
            },
            {
              "name": "Your Organization Only",
              "value": 0
            }
          ]
        },
        {
          "displayName": "Sharing Group Name or ID",
          "name": "sharing_group_id",
          "type": "options",
          "default": "",
          "description": "Use only for when <code>Sharing Group</code> is selected in <code>Distribution</code>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getSharingGroups"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Attribute ID",
      "name": "attributeId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the attribute",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Attribute ID",
      "name": "attributeId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the attribute",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Use JSON to Specify Fields",
      "name": "useJson",
      "type": "boolean",
      "default": false,
      "description": "Whether to use JSON to specify the fields for the search request",
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "JSON",
      "name": "jsonOutput",
      "type": "json",
      "default": "{\n  \"value\": \"search value\",\n  \"type\": \"text\"\n}\n",
      "description": "Get more info at {YOUR_BASE_URL_SPECIFIED_IN_CREDENTIALS}/api/openapi#operation/restSearchAttributes",
      "displayOptions": {
        "show": {
          "useJson": [
            true
          ],
          "resource": [
            "attribute"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "useJson": [
            false
          ],
          "resource": [
            "attribute"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category",
          "name": "category",
          "type": "string",
          "placeholder": "e.g. Internal reference",
          "default": ""
        },
        {
          "displayName": "Deleted",
          "name": "deleted",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Search All",
          "name": "searchall",
          "type": "string",
          "description": "Search by matching any tag names, event descriptions, attribute values or attribute comments",
          "default": "",
          "displayOptions": {
            "hide": {
              "/resource": [
                "attribute"
              ]
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "placeholder": "e.g. tag1,tag2",
          "hint": "Comma-separated list of tags",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "placeholder": "e.g. text",
          "default": ""
        },
        {
          "displayName": "Published",
          "name": "published",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "useJson": [
            false
          ],
          "resource": [
            "attribute"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Attribute ID",
      "name": "attributeId",
      "type": "string",
      "default": "",
      "description": "ID of the attribute to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Distribution",
          "name": "distribution",
          "type": "options",
          "default": 0,
          "description": "Who will be able to see this event once published",
          "options": [
            {
              "name": "All Communities",
              "value": 3
            },
            {
              "name": "Connected Communities",
              "value": 2
            },
            {
              "name": "Inherit Event",
              "value": 5
            },
            {
              "name": "Sharing Group",
              "value": 4
            },
            {
              "name": "This Community Only",
              "value": 1
            },
            {
              "name": "Your Organization Only",
              "value": 0
            }
          ]
        },
        {
          "displayName": "Sharing Group Name or ID",
          "name": "sharing_group_id",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Use only for when <code>Sharing Group</code> is selected in <code>Distribution</code>.",
          "typeOptions": {
            "loadOptionsMethod": "getSharingGroups"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "attribute"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an event"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an event"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an event"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many events"
        },
        {
          "name": "Publish",
          "value": "publish",
          "action": "Publish an event"
        },
        {
          "name": "Search",
          "value": "search",
          "action": "Get a filtered list of events"
        },
        {
          "name": "Unpublish",
          "value": "unpublish",
          "action": "Unpublish an event"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an event"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Name or ID",
      "name": "org_id",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrgs"
      }
    },
    {
      "displayName": "Information",
      "name": "information",
      "type": "string",
      "default": "",
      "description": "Information on the event - max 65535 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Analysis",
          "name": "analysis",
          "type": "options",
          "default": 0,
          "description": "Analysis maturity level of the event",
          "options": [
            {
              "name": "Initial",
              "value": 0
            },
            {
              "name": "Ongoing",
              "value": 1
            },
            {
              "name": "Complete",
              "value": 2
            }
          ]
        },
        {
          "displayName": "Distribution",
          "name": "distribution",
          "type": "options",
          "default": 0,
          "description": "Who will be able to see this event once published",
          "options": [
            {
              "name": "All Communities",
              "value": 3
            },
            {
              "name": "Connected Communities",
              "value": 2
            },
            {
              "name": "Inherit Event",
              "value": 5
            },
            {
              "name": "Sharing Group",
              "value": 4
            },
            {
              "name": "This Community Only",
              "value": 1
            },
            {
              "name": "Your Organization Only",
              "value": 0
            }
          ]
        },
        {
          "displayName": "Sharing Group Name or ID",
          "name": "sharing_group_id",
          "type": "options",
          "default": "",
          "description": "Use only for when <code>Sharing Group</code> is selected in <code>Distribution</code>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getSharingGroups"
          }
        },
        {
          "displayName": "Threat Level ID",
          "name": "threat_level_id",
          "type": "options",
          "default": 1,
          "options": [
            {
              "name": "High",
              "value": 1
            },
            {
              "name": "Medium",
              "value": 2
            },
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "Undefined",
              "value": 4
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "unpublish"
          ]
        }
      }
    },
    {
      "displayName": "Use JSON to Specify Fields",
      "name": "useJson",
      "type": "boolean",
      "default": false,
      "description": "Whether to use JSON to specify the fields for the search request",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "JSON",
      "name": "jsonOutput",
      "type": "json",
      "default": "{\n  \"value\": \"search value\",\n  \"type\": \"text\"\n}\n",
      "description": "Get more info at {YOUR_BASE_URL_SPECIFIED_IN_CREDENTIALS}/api/openapi#operation/restSearchAttributes",
      "displayOptions": {
        "show": {
          "useJson": [
            true
          ],
          "resource": [
            "event"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "useJson": [
            false
          ],
          "resource": [
            "event"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category",
          "name": "category",
          "type": "string",
          "placeholder": "e.g. Internal reference",
          "default": ""
        },
        {
          "displayName": "Deleted",
          "name": "deleted",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Search All",
          "name": "searchall",
          "type": "string",
          "description": "Search by matching any tag names, event descriptions, attribute values or attribute comments",
          "default": "",
          "displayOptions": {
            "hide": {
              "/resource": [
                "attribute"
              ]
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "placeholder": "e.g. tag1,tag2",
          "hint": "Comma-separated list of tags",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "placeholder": "e.g. text",
          "default": ""
        },
        {
          "displayName": "Published",
          "name": "published",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "useJson": [
            false
          ],
          "resource": [
            "event"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Analysis",
          "name": "analysis",
          "type": "options",
          "default": 0,
          "description": "Analysis maturity level of the event",
          "options": [
            {
              "name": "Initial",
              "value": 0
            },
            {
              "name": "Ongoing",
              "value": 1
            },
            {
              "name": "Complete",
              "value": 2
            }
          ]
        },
        {
          "displayName": "Distribution",
          "name": "distribution",
          "type": "options",
          "default": 0,
          "description": "Who will be able to see this event once published",
          "options": [
            {
              "name": "All Communities",
              "value": 3
            },
            {
              "name": "Connected Communities",
              "value": 2
            },
            {
              "name": "Inherit Event",
              "value": 5
            },
            {
              "name": "Sharing Group",
              "value": 4
            },
            {
              "name": "This Community Only",
              "value": 1
            },
            {
              "name": "Your Organization Only",
              "value": 0
            }
          ]
        },
        {
          "displayName": "Information",
          "name": "information",
          "type": "string",
          "default": "",
          "description": "Information on the event - max 65535 characters"
        },
        {
          "displayName": "Sharing Group Name or ID",
          "name": "sharing_group_id",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Use only for when <code>Sharing Group</code> is selected in <code>Distribution</code>.",
          "typeOptions": {
            "loadOptionsMethod": "getSharingGroups"
          }
        },
        {
          "displayName": "Threat Level ID",
          "name": "threat_level_id",
          "type": "options",
          "default": 1,
          "options": [
            {
              "name": "High",
              "value": 1
            },
            {
              "name": "Medium",
              "value": 2
            },
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "Undefined",
              "value": 4
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a tag to an event"
        },
        {
          "name": "Remove",
          "value": "remove",
          "action": "Remove a tag from an event"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "eventTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "eventTag"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tagId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "eventTag"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "eventTag"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tagId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "eventTag"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a feed"
        },
        {
          "name": "Disable",
          "value": "disable",
          "action": "Disable a feed"
        },
        {
          "name": "Enable",
          "value": "enable",
          "action": "Enable a feed"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a feed"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many feeds"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a feed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Provider",
      "name": "provider",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Distribution",
          "name": "distribution",
          "type": "options",
          "default": 0,
          "description": "Who will be able to see this event once published",
          "options": [
            {
              "name": "All Communities",
              "value": 3
            },
            {
              "name": "Connected Communities",
              "value": 2
            },
            {
              "name": "Inherit Event",
              "value": 5
            },
            {
              "name": "Sharing Group",
              "value": 4
            },
            {
              "name": "This Community Only",
              "value": 1
            },
            {
              "name": "Your Organization Only",
              "value": 0
            }
          ]
        },
        {
          "displayName": "Rules",
          "name": "json",
          "type": "string",
          "default": "",
          "description": "Filter rules for the feed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Feed ID",
      "name": "feedId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the feed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "disable"
          ]
        }
      }
    },
    {
      "displayName": "Feed ID",
      "name": "feedId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the feed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "enable"
          ]
        }
      }
    },
    {
      "displayName": "Feed ID",
      "name": "feedId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the feed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Feed ID",
      "name": "feedId",
      "type": "string",
      "default": "",
      "description": "ID of the feed to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Distribution",
          "name": "distribution",
          "type": "options",
          "default": 0,
          "description": "Who will be able to see this event once published",
          "options": [
            {
              "name": "All Communities",
              "value": 3
            },
            {
              "name": "Connected Communities",
              "value": 2
            },
            {
              "name": "Inherit Event",
              "value": 5
            },
            {
              "name": "Sharing Group",
              "value": 4
            },
            {
              "name": "This Community Only",
              "value": 1
            },
            {
              "name": "Your Organization Only",
              "value": 0
            }
          ]
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Provider",
          "name": "provider",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Rules",
          "name": "rules",
          "type": "json",
          "default": "",
          "description": "Filter rules for the feed"
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "feed"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a galaxy"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a galaxy"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many galaxies"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "galaxy"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Galaxy ID",
      "name": "galaxyId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the galaxy",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "galaxy"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Galaxy ID",
      "name": "galaxyId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the galaxy",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "galaxy"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "galaxy"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "galaxy"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a noticelist"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many noticelists"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "noticelist"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Noticelist ID",
      "name": "noticelistId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the noticelist",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "noticelist"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "noticelist"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "noticelist"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "search",
      "options": [
        {
          "name": "Search",
          "value": "search",
          "action": "Get a filtered list of objects"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Use JSON to Specify Fields",
      "name": "useJson",
      "type": "boolean",
      "default": false,
      "description": "Whether to use JSON to specify the fields for the search request",
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "JSON",
      "name": "jsonOutput",
      "type": "json",
      "default": "{\n  \"value\": \"search value\",\n  \"type\": \"text\"\n}\n",
      "description": "Get more info at {YOUR_BASE_URL_SPECIFIED_IN_CREDENTIALS}/api/openapi#operation/restSearchAttributes",
      "displayOptions": {
        "show": {
          "useJson": [
            true
          ],
          "resource": [
            "object"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "useJson": [
            false
          ],
          "resource": [
            "object"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category",
          "name": "category",
          "type": "string",
          "placeholder": "e.g. Internal reference",
          "default": ""
        },
        {
          "displayName": "Deleted",
          "name": "deleted",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Search All",
          "name": "searchall",
          "type": "string",
          "description": "Search by matching any tag names, event descriptions, attribute values or attribute comments",
          "default": "",
          "displayOptions": {
            "hide": {
              "/resource": [
                "attribute"
              ]
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "placeholder": "e.g. tag1,tag2",
          "hint": "Comma-separated list of tags",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "placeholder": "e.g. text",
          "default": ""
        },
        {
          "displayName": "Published",
          "name": "published",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "useJson": [
            false
          ],
          "resource": [
            "object"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an organization"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an organization"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an organization"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many organizations"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Created by Email",
          "name": "created_by_email",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Nationality",
          "name": "nationality",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Sector",
          "name": "sector",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "User Count",
          "name": "usercount",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organisation ID",
      "name": "organisationId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the organisation",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organisation ID",
      "name": "organisationId",
      "type": "string",
      "default": "",
      "description": "UUID or numeric ID of the organisation",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Organisation ID",
      "name": "organisationId",
      "type": "string",
      "default": "",
      "description": "ID of the organisation to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Nationality",
          "name": "nationality",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Sector",
          "name": "sector",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organisation"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a tag"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a tag"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many tags"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a tag"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Color",
          "description": "Hex color code for the tag",
          "name": "colour",
          "type": "color",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the attribute",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "description": "ID of the tag to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Color",
          "description": "Hex color code for the tag",
          "name": "colour",
          "type": "color",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many users"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Role ID",
      "name": "role_id",
      "type": "string",
      "default": "",
      "description": "Role IDs are available in the MISP dashboard at /roles/index",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "GPG Key",
          "name": "gpgkey",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Inviter Email or ID",
          "name": "invited_by",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          }
        },
        {
          "displayName": "Organization Name or ID",
          "name": "org_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getOrgs"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "ID of the user to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "GPG Key",
          "name": "gpgkey",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Inviter Name or ID",
          "name": "invited_by",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          }
        },
        {
          "displayName": "Organization Name or ID",
          "name": "org_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getOrgs"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a warninglist"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many warninglists"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "warninglist"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Warninglist ID",
      "name": "warninglistId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the warninglist",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "warninglist"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "warninglist"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "warninglist"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create"
    },
    {
      "operation": "delete",
      "name": "Delete"
    },
    {
      "operation": "get",
      "name": "Get"
    },
    {
      "operation": "getAll",
      "name": "Get Many"
    },
    {
      "operation": "search",
      "name": "Search"
    },
    {
      "operation": "update",
      "name": "Update"
    }
  ]


node_type: nodes-base.mocean
package_name: n8n-nodes-base
display_name: Mocean
description: Send SMS and voice messages via Mocean
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "moceanApi",
  "required": true,
  "testedBy": "moceanApiTest"
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mocean node documentation
  description: Learn how to use the Mocean node in n8n. Follow technical documentation to integrate Mocean node into your workflows.
  contentType: [integration, reference]
  ---

  # Mocean node

  Use the Mocean node to automate work in Mocean, and integrate Mocean with other applications. n8n has built-in support for a wide range of Mocean features, including sending SMS, and voice messages. 

  On this page, you'll find a list of operations the Mocean node supports and links to more resources.

  /// note | Credentials
  Refer to [Mocean credentials](/integrations/builtin/credentials/mocean.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * SMS
      * Send SMS/Voice message
  * Voice
      * Send SMS/Voice message

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mocean') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "sms",
      "options": [
        {
          "name": "SMS",
          "value": "sms"
        },
        {
          "name": "Voice",
          "value": "voice"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send SMS/Voice message",
          "action": "Send an SMS"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sms",
            "voice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From",
      "name": "from",
      "type": "string",
      "default": "",
      "description": "Number to which to send the message",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms",
            "voice"
          ]
        }
      }
    },
    {
      "displayName": "To",
      "name": "to",
      "type": "string",
      "default": "",
      "description": "Number from which to send the message",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms",
            "voice"
          ]
        }
      }
    },
    {
      "displayName": "Language",
      "name": "language",
      "type": "options",
      "default": "en-US",
      "options": [
        {
          "name": "Chinese Mandarin (China)",
          "value": "cmn-CN"
        },
        {
          "name": "English (United Kingdom)",
          "value": "en-GB"
        },
        {
          "name": "English (United States)",
          "value": "en-US"
        },
        {
          "name": "Japanese (Japan)",
          "value": "ja-JP"
        },
        {
          "name": "Korean (Korea)",
          "value": "ko-KR"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "voice"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Message to send",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms",
            "voice"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delivery Report URL",
          "name": "dlrUrl",
          "type": "string",
          "default": "",
          "placeholder": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send",
      "description": "Send SMS/Voice message"
    }
  ]


node_type: nodes-base.mondayCom
package_name: n8n-nodes-base
display_name: Monday.com
description: Consume Monday.com API
category: output
development_style: programmatic
version: 1
updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: monday.com node documentation
  description: Learn how to use the monday.com node in n8n. Follow technical documentation to integrate monday.com node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # monday.com node

  Use the monday.com node to automate work in monday.com, and integrate monday.com with other applications. n8n has built-in support for a wide range of monday.com features, including creating a new board, and adding, deleting, and getting items on the board.

  On this page, you'll find a list of operations the monday.com node supports and links to more resources.

  /// warning | Minimum required version
  This node requires n8n version 1.22.6 or above.
  ///

  /// note | Credentials
  Refer to [monday.com credentials](/integrations/builtin/credentials/mondaycom.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Board
      * Archive a board
      * Create a new board
      * Get a board
      * Get all boards
  * Board Column
      * Create a new column
      * Get all columns
  * Board Group
      * Delete a group in a board
      * Create a group in a board
      * Get list of groups in a board
  * Board Item
      * Add an update to an item.
      * Change a column value for a board item
      * Change multiple column values for a board item
      * Create an item in a board's group
      * Delete an item
      * Get an item
      * Get all items
      * Get items by column value
      * Move item to group

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mondaycom') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "board",
      "options": [
        {
          "name": "Board",
          "value": "board"
        },
        {
          "name": "Board Column",
          "value": "boardColumn"
        },
        {
          "name": "Board Group",
          "value": "boardGroup"
        },
        {
          "name": "Board Item",
          "value": "boardItem"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Archive",
          "value": "archive",
          "description": "Archive a board",
          "action": "Archive a board"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new board",
          "action": "Create a board"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a board",
          "action": "Get a board"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many boards",
          "action": "Get many boards"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "board"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Board unique identifiers. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "board"
          ],
          "operation": [
            "archive"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The board's name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "board"
          ]
        }
      }
    },
    {
      "displayName": "Kind",
      "name": "kind",
      "type": "options",
      "default": "",
      "description": "The board's kind (public / private / share)",
      "options": [
        {
          "name": "Share",
          "value": "share"
        },
        {
          "name": "Public",
          "value": "public"
        },
        {
          "name": "Private",
          "value": "private"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "board"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Template ID",
          "name": "templateId",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "Optional board template ID"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "board"
          ]
        }
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Board unique identifiers. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "board"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "board"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "board"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new column",
          "action": "Create a board column"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many columns",
          "action": "Get many board columns"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "boardColumn"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardColumn"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardColumn"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Column Type",
      "name": "columnType",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Checkbox",
          "value": "checkbox"
        },
        {
          "name": "Country",
          "value": "country"
        },
        {
          "name": "Date",
          "value": "date"
        },
        {
          "name": "Dropdown",
          "value": "dropdown"
        },
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Hour",
          "value": "hour"
        },
        {
          "name": "Link",
          "value": "Link"
        },
        {
          "name": "Long Text",
          "value": "longText"
        },
        {
          "name": "Numbers",
          "value": "numbers"
        },
        {
          "name": "People",
          "value": "people"
        },
        {
          "name": "Person",
          "value": "person"
        },
        {
          "name": "Phone",
          "value": "phone"
        },
        {
          "name": "Rating",
          "value": "rating"
        },
        {
          "name": "Status",
          "value": "status"
        },
        {
          "name": "Tags",
          "value": "tags"
        },
        {
          "name": "Team",
          "value": "team"
        },
        {
          "name": "Text",
          "value": "text"
        },
        {
          "name": "Timeline",
          "value": "timeline"
        },
        {
          "name": "Timezone",
          "value": "timezone"
        },
        {
          "name": "Week",
          "value": "week"
        },
        {
          "name": "World Clock",
          "value": "worldClock"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardColumn"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Defauls",
          "name": "defaults",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "The new column's defaults"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "boardColumn"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardColumn"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a group in a board",
          "action": "Delete a board group"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a group in a board",
          "action": "Create a board group"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get list of groups in a board",
          "action": "Get many board groups"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "boardGroup"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardGroup"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The group name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "boardGroup"
          ]
        }
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardGroup"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Group Name or ID",
      "name": "groupId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardGroup"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGroups",
        "loadOptionsDependsOn": [
          "boardId"
        ]
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardGroup"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add Update",
          "value": "addUpdate",
          "description": "Add an update to an item",
          "action": "Add an update to an item"
        },
        {
          "name": "Change Column Value",
          "value": "changeColumnValue",
          "description": "Change a column value for a board item",
          "action": "Change a column value for a board item"
        },
        {
          "name": "Change Multiple Column Values",
          "value": "changeMultipleColumnValues",
          "description": "Change multiple column values for a board item",
          "action": "Change multiple column values for a board item"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create an item in a board's group",
          "action": "Create an item in a board's group"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an item",
          "action": "Delete an item"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an item",
          "action": "Get an item"
        },
        {
          "name": "Get By Column Value",
          "value": "getByColumnValue",
          "description": "Get items by column value",
          "action": "Get items item by column value"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many items",
          "action": "Get many items"
        },
        {
          "name": "Move",
          "value": "move",
          "description": "Move item to group",
          "action": "Move an item to a group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "The unique identifier of the item to add update to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "addUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Update Text",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The update text to add",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "addUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "The unique identifier of the board. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeColumnValue"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "The unique identifier of the item to change column of",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeColumnValue"
          ]
        }
      }
    },
    {
      "displayName": "Column Name or ID",
      "name": "columnId",
      "type": "options",
      "default": "",
      "description": "The column's unique identifier. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeColumnValue"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getColumns",
        "loadOptionsDependsOn": [
          "boardId"
        ]
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "json",
      "default": "",
      "description": "The column value in JSON format. Documentation can be found <a href=\"https://monday.com/developers/v2#mutations-section-columns-change-column-value\">here</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeColumnValue"
          ]
        }
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "The unique identifier of the board. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeMultipleColumnValues"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "Item's ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeMultipleColumnValues"
          ]
        }
      }
    },
    {
      "displayName": "Column Values",
      "name": "columnValues",
      "type": "json",
      "default": "",
      "description": "The column fields and values in JSON format. Documentation can be found <a href=\"https://monday.com/developers/v2#mutations-section-columns-change-multiple-column-values\">here</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "changeMultipleColumnValues"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Group Name or ID",
      "name": "groupId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGroups",
        "loadOptionsDependsOn": [
          "boardId"
        ]
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The new item's name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "boardItem"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Column Values",
          "name": "columnValues",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "The column values of the new item"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "boardItem"
          ]
        }
      }
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "Item's ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "Item's ID (Multiple can be added separated by comma)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Group Name or ID",
      "name": "groupId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGroups",
        "loadOptionsDependsOn": [
          "boardId"
        ]
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "The unique identifier of the board. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getByColumnValue"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Column Name or ID",
      "name": "columnId",
      "type": "options",
      "default": "",
      "description": "The column's unique identifier. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getByColumnValue"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getColumns",
        "loadOptionsDependsOn": [
          "boardId"
        ]
      }
    },
    {
      "displayName": "Column Value",
      "name": "columnValue",
      "type": "string",
      "default": "",
      "description": "The column value to search items by",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getByColumnValue"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getByColumnValue"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "getByColumnValue"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Board Name or ID",
      "name": "boardId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "move"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBoards"
      }
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "The item's ID",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "move"
          ],
          "resource": [
            "boardItem"
          ]
        }
      }
    },
    {
      "displayName": "Group Name or ID",
      "name": "groupId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "boardItem"
          ],
          "operation": [
            "move"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGroups",
        "loadOptionsDependsOn": [
          "boardId"
        ]
      }
    }
  ]

operations:
  [
    {
      "operation": "archive",
      "name": "Archive",
      "description": "Archive a board"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new board"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a board"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many boards"
    }
  ]

credentials_required:
  [
    {
      "name": "mondayComApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "mondayComOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mongoDb
package_name: n8n-nodes-base
display_name: MongoDB
description: Find, insert and update documents in MongoDB
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mongoDb",
  "required": true,
  "testedBy": "mongoDbCredentialTest"
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MongoDB node documentation
  description: Learn how to use the MongoDB node in n8n. Follow technical documentation to integrate MongoDB node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # MongoDB node

  Use the MongoDB node to automate work in MongoDB, and integrate MongoDB with other applications. n8n has built-in support for a wide range of MongoDB features, including aggregating, updating, finding, deleting, and getting documents. 

  On this page, you'll find a list of operations the MongoDB node supports and links to more resources.

  /// note | Credentials
  Refer to [MongoDB credentials](/integrations/builtin/credentials/mongodb.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Aggregate documents
  * Delete documents
  * Find documents
  * Find and replace documents
  * Find and update documents
  * Insert documents
  * Update documents

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mongodb') ]]

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "find",
      "options": [
        {
          "name": "Aggregate",
          "value": "aggregate",
          "description": "Aggregate documents",
          "action": "Aggregate documents"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete documents",
          "action": "Delete documents"
        },
        {
          "name": "Find",
          "value": "find",
          "description": "Find documents",
          "action": "Find documents"
        },
        {
          "name": "Find And Replace",
          "value": "findOneAndReplace",
          "description": "Find and replace documents",
          "action": "Find and replace documents"
        },
        {
          "name": "Find And Update",
          "value": "findOneAndUpdate",
          "description": "Find and update documents",
          "action": "Find and update documents"
        },
        {
          "name": "Insert",
          "value": "insert",
          "description": "Insert documents",
          "action": "Insert documents"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update documents",
          "action": "Update documents"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Collection",
      "name": "collection",
      "type": "string",
      "default": "",
      "description": "MongoDB Collection",
      "required": true
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "json",
      "default": "",
      "description": "MongoDB aggregation pipeline query in JSON format",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "aggregate"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Delete Query (JSON Format)",
      "name": "query",
      "type": "json",
      "default": "{}",
      "description": "MongoDB Delete query",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "description": "Add query options",
      "options": [
        {
          "displayName": "Limit",
          "name": "limit",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 0,
          "description": "Use limit to specify the maximum number of documents or 0 for unlimited documents"
        },
        {
          "displayName": "Skip",
          "name": "skip",
          "type": "number",
          "default": 0,
          "description": "The number of documents to skip in the results set"
        },
        {
          "displayName": "Sort (JSON Format)",
          "name": "sort",
          "type": "json",
          "typeOptions": {
            "rows": 2
          },
          "default": "{}",
          "placeholder": "{ \"field\": -1 }",
          "description": "A JSON that defines the sort order of the result set"
        },
        {
          "displayName": "Projection (JSON Format)",
          "name": "projection",
          "type": "json",
          "typeOptions": {
            "rows": 4
          },
          "default": "{}",
          "placeholder": "{ \"_id\": 0, \"field\": 1 }",
          "description": "A JSON that defines a selection of fields to retrieve or exclude from the result set"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "find"
          ]
        }
      }
    },
    {
      "displayName": "Query (JSON Format)",
      "name": "query",
      "type": "json",
      "default": "{}",
      "description": "MongoDB Find query",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "find"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Fields",
      "name": "fields",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the fields to be included into the new document",
      "displayOptions": {
        "show": {
          "operation": [
            "insert"
          ]
        }
      }
    },
    {
      "displayName": "Update Key",
      "name": "updateKey",
      "type": "string",
      "default": "id",
      "description": "Name of the property which decides which rows in the database should be updated. Normally that would be \"id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update",
            "findOneAndReplace",
            "findOneAndUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Fields",
      "name": "fields",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the fields to be included into the new document",
      "displayOptions": {
        "show": {
          "operation": [
            "update",
            "findOneAndReplace",
            "findOneAndUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Upsert",
      "name": "upsert",
      "type": "boolean",
      "default": false,
      "description": "Whether to perform an insert if no documents match the update key",
      "displayOptions": {
        "show": {
          "operation": [
            "update",
            "findOneAndReplace",
            "findOneAndUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date Fields",
          "name": "dateFields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields that will be parsed as Mongo Date type"
        },
        {
          "displayName": "Use Dot Notation",
          "name": "useDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use dot notation to access date fields"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update",
            "insert",
            "findOneAndReplace",
            "findOneAndUpdate"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "aggregate",
      "name": "Aggregate",
      "description": "Aggregate documents"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete documents"
    },
    {
      "operation": "find",
      "name": "Find",
      "description": "Find documents"
    },
    {
      "operation": "findOneAndReplace",
      "name": "Find And Replace",
      "description": "Find and replace documents"
    },
    {
      "operation": "findOneAndUpdate",
      "name": "Find And Update",
      "description": "Find and update documents"
    },
    {
      "operation": "insert",
      "name": "Insert",
      "description": "Insert documents"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update documents"
    }
  ]


node_type: nodes-base.monicaCrm
package_name: n8n-nodes-base
display_name: Monica CRM
description: Consume the Monica CRM API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "monicaCrmApi",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Monica CRM node documentation
  description: Learn how to use the Monica CRM node in n8n. Follow technical documentation to integrate Monica CRM node into your workflows.
  contentType: [integration, reference]
  ---

  # Monica CRM node

  Use the Monica CRM node to automate work in Monica CRM, and integrate Monica CRM with other applications. n8n has built-in support for a wide range of Monica CRM features, including creating, updating, deleting, and getting activities, calls, contracts, messages, tasks, and notes. 

  On this page, you'll find a list of operations the Monica CRM node supports and links to more resources.

  /// note | Credentials
  Refer to [Monica CRM credentials](/integrations/builtin/credentials/monicacrm.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Activity
      * Create an activity
      * Delete an activity
      * Retrieve an activity
      * Retrieve all activities
      * Update an activity
  * Call
      * Create a call
      * Delete a call
      * Retrieve a call
      * Retrieve all calls
      * Update a call
  * Contact
      * Create a contact
      * Delete a contact
      * Retrieve a contact
      * Retrieve all contacts
      * Update a contact
  * Contact Field
      * Create a contact field
      * Delete a contact field
      * Retrieve a contact field
      * Update a contact field
  * Contact Tag
      * Add
      * Remove
  * Conversation
      * Create a conversation
      * Delete a conversation
      * Retrieve a conversation
      * Update a conversation
  * Conversation Message
      * Add a message to a conversation
      * Update a message in a conversation
  * Journal Entry
      * Create a journal entry
      * Delete a journal entry
      * Retrieve a journal entry
      * Retrieve all journal entries
      * Update a journal entry
  * Note
      * Create a note
      * Delete a note
      * Retrieve a note
      * Retrieve all notes
      * Update a note
  * Reminder
      * Create a reminder
      * Delete a reminder
      * Retrieve a reminder
      * Retrieve all reminders
      * Update a reminder
  * Tag
      * Create a tag
      * Delete a tag
      * Retrieve a tag
      * Retrieve all tags
      * Update a tag
  * Task
      * Create a task
      * Delete a task
      * Retrieve a task
      * Retrieve all tasks
      * Update a task

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'monica-crm') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Call",
          "value": "call"
        },
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Contact Field",
          "value": "contactField"
        },
        {
          "name": "Contact Tag",
          "value": "contactTag"
        },
        {
          "name": "Conversation",
          "value": "conversation"
        },
        {
          "name": "Conversation Message",
          "value": "conversationMessage"
        },
        {
          "name": "Journal Entry",
          "value": "journalEntry"
        },
        {
          "name": "Note",
          "value": "note"
        },
        {
          "name": "Reminder",
          "value": "reminder"
        },
        {
          "name": "Tag",
          "value": "tag"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an activity",
          "action": "Create an activity"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an activity",
          "action": "Delete an activity"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve an activity",
          "action": "Get an activity"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many activities",
          "action": "Get many activities"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an activity",
          "action": "Update an activity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Activity Type Name or ID",
      "name": "activityTypeId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getActivityTypes"
      }
    },
    {
      "displayName": "Contacts",
      "name": "contacts",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of IDs of the contacts to associate the activity with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Happened At",
      "name": "happenedAt",
      "type": "dateTime",
      "default": "",
      "description": "Date when the activity happened",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Summary",
      "name": "summary",
      "type": "string",
      "default": "",
      "description": "Brief description of the activity - max 255 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the activity - max 100,000 characters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "string",
      "default": "",
      "description": "ID of the activity to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "string",
      "default": "",
      "description": "ID of the activity to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "string",
      "default": "",
      "description": "ID of the activity to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Activity Type Name or ID",
          "name": "activity_type_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getActivityTypes"
          }
        },
        {
          "displayName": "Contacts",
          "name": "contacts",
          "description": "IDs of the contacts to associate the activity with",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description to add more details on the activity - max 100,000 characters"
        },
        {
          "displayName": "Happened At",
          "name": "happened_at",
          "description": "Date when the activity happened",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Summary",
          "name": "summary",
          "description": "Brief description of the activity - max 255 characters",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a call",
          "action": "Create a call"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a call",
          "action": "Delete a call"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a call",
          "action": "Get a call"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many calls",
          "action": "Get many calls"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a call",
          "action": "Update a call"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the call with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Called At",
      "name": "calledAt",
      "type": "dateTime",
      "default": "",
      "description": "Date when the call happened",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Description",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "Description of the call - max 100,000 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Call ID",
      "name": "callId",
      "type": "string",
      "default": "",
      "description": "ID of the call to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Call ID",
      "name": "callId",
      "type": "string",
      "default": "",
      "description": "ID of the call to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Call ID",
      "name": "callId",
      "type": "string",
      "default": "",
      "description": "ID of the call to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Called At",
          "name": "calledAt",
          "description": "Date when the call happened",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Contact ID",
          "name": "contactId",
          "description": "ID of the contact to associate the call with",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "content",
          "description": "Description of the call - max 100,000 characters",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "call"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a contact",
          "action": "Create a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many contacts",
          "action": "Get many contacts"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a contact",
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Gender Name or ID",
      "name": "genderId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGenders"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Birthdate",
          "name": "birthdate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Deceased Date",
          "name": "deceasedDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deceased",
          "name": "isDeceased",
          "description": "Whether the contact has passed away",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Nickname",
          "name": "nickname",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "is_partial",
          "type": "options",
          "default": false,
          "options": [
            {
              "name": "Real",
              "value": false,
              "description": "Contact with their own contact sheet"
            },
            {
              "name": "Partial",
              "value": true,
              "description": "Contact without their own contact sheet"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Search Term",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Search term to filter results by"
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "options",
          "options": [
            {
              "name": "Ascended Created At",
              "value": "created_at"
            },
            {
              "name": "Descended Created At",
              "value": "-created_at"
            },
            {
              "name": "Ascended Updated At",
              "value": "updated_at"
            },
            {
              "name": "Descended Updated At",
              "value": "-updated_at"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Birthdate",
          "name": "birthdate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Deceased Date",
          "name": "deceased_date",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Gender Name or ID",
          "name": "gender_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getGenders"
          }
        },
        {
          "displayName": "Is Deceased",
          "name": "is_deceased",
          "description": "Whether the contact has passed away",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Nickname",
          "name": "nickname",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "is_partial",
          "type": "options",
          "default": false,
          "options": [
            {
              "name": "Real",
              "value": false,
              "description": "Contact with their own contact sheet"
            },
            {
              "name": "Partial",
              "value": true,
              "description": "Contact without their own contact sheet"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a contact field",
          "action": "Create a contact field"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact field",
          "action": "Delete a contact field"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a contact field",
          "action": "Get a contact field"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a contact field",
          "action": "Update a contact field"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the contact field with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field Type Name or ID",
      "name": "contactFieldTypeId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContactFieldTypes"
      }
    },
    {
      "displayName": "Content",
      "name": "data",
      "type": "string",
      "default": "",
      "description": "Content of the contact field - max 255 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field ID",
      "name": "contactFieldId",
      "type": "string",
      "default": "",
      "description": "ID of the contactField to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field ID",
      "name": "contactFieldId",
      "type": "string",
      "default": "",
      "description": "ID of the contact field to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact whose fields to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the contact field with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field ID",
      "name": "contactFieldId",
      "type": "string",
      "default": "",
      "description": "ID of the contact field to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field Type Name or ID",
      "name": "contactFieldTypeId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContactFieldTypes"
      }
    },
    {
      "displayName": "Content",
      "name": "data",
      "type": "string",
      "default": "",
      "description": "Content of the contact field - max 255 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactField"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a tag to a contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "action": "Remove a tag from a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to add a tag to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactTag"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Tag Names or IDs",
      "name": "tagsToAdd",
      "type": "multiOptions",
      "default": [],
      "description": "Tags to add to the contact. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactTag"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTagsToAdd"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to remove the tag from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactTag"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Tag Names or IDs",
      "name": "tagsToRemove",
      "type": "multiOptions",
      "default": [],
      "description": "Tags to remove from the contact. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactTag"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTagsToRemove"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a conversation",
          "action": "Create a conversation"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a conversation",
          "action": "Delete a conversation"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a conversation",
          "action": "Get a conversation"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a conversation",
          "action": "Update a conversation"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the conversation with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field Type Name or ID",
      "name": "contactFieldTypeId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContactFieldTypes"
      }
    },
    {
      "displayName": "Happened At",
      "name": "happenedAt",
      "type": "dateTime",
      "default": "",
      "description": "Date when the conversation happened",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "description": "ID of the conversation to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "description": "ID of the conversation to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "description": "ID of the conversation to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact Field Type Name or ID",
      "name": "contactFieldTypeId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContactFieldTypes"
      }
    },
    {
      "displayName": "Happened At",
      "name": "happenedAt",
      "type": "dateTime",
      "default": "",
      "description": "Date when the conversation happened",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a message to a conversation",
          "action": "Add a message to a conversation"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a message in a conversation",
          "action": "Update a message in a conversation"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "description": "ID of the contact whose conversation",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "Content of the message",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Written At",
      "name": "writtenAt",
      "type": "dateTime",
      "default": "",
      "description": "Date when the message was written",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Written By",
      "name": "writtenByMe",
      "type": "options",
      "default": true,
      "description": "Author of the message",
      "options": [
        {
          "name": "User",
          "value": true
        },
        {
          "name": "Contact",
          "value": false
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Message ID",
      "name": "messageId",
      "type": "string",
      "default": "",
      "description": "ID of the message to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "description": "ID of the conversation whose message to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Contact ID",
          "name": "contact_id",
          "description": "ID of the contact to associate the conversationMessage with",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Content",
          "name": "content",
          "description": "Content of the message",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Written At",
          "name": "written_at",
          "description": "Date when the message was written",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Written By",
          "name": "written_by_me",
          "description": "Author of the message",
          "type": "options",
          "default": true,
          "options": [
            {
              "name": "User",
              "value": true
            },
            {
              "name": "Contact",
              "value": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversationMessage"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a journal entry",
          "action": "Create a journal entry"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a journal entry",
          "action": "Delete a journal entry"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a journal entry",
          "action": "Get a journal entry"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many journal entries",
          "action": "Get many journal entries"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a journal entry",
          "action": "Update a journal entry"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the journal entry - max 250 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Content",
      "name": "post",
      "type": "string",
      "default": "",
      "description": "Content of the journal entry - max 100,000 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Journal Entry ID",
      "name": "journalId",
      "type": "string",
      "default": "",
      "description": "ID of the journal entry to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Journal Entry ID",
      "name": "journalId",
      "type": "string",
      "default": "",
      "description": "ID of the journal entry to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Journal Entry ID",
      "name": "journalId",
      "type": "string",
      "default": "",
      "description": "ID of the journal entry to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Content",
          "name": "post",
          "description": "Content of the journal entry - max 100,000 characters",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Title",
          "name": "title",
          "description": "Title of the journal entry - max 250 characters",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "journalEntry"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a note",
          "action": "Create a note"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a note",
          "action": "Delete a note"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a note",
          "action": "Get a note"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many notes",
          "action": "Get many notes"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a note",
          "action": "Update a note"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the note with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "body",
      "type": "string",
      "default": "",
      "description": "Body of the note - max 100,000 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Is Favorited",
          "name": "isFavorited",
          "description": "Whether the note has been favorited",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "string",
      "default": "",
      "description": "ID of the note to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "string",
      "default": "",
      "description": "ID of the note to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "string",
      "default": "",
      "description": "ID of the note to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Body",
          "name": "body",
          "description": "Body of the note - max 100,000 characters",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Contact ID",
          "name": "contact_id",
          "description": "ID of the contact to associate the note with",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Favorited",
          "name": "is_favorited",
          "description": "Whether the note has been favorited",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a reminder",
          "action": "Create a reminder"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a reminder",
          "action": "Delete a reminder"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a reminder",
          "action": "Get a reminder"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many reminders",
          "action": "Get many reminders"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a reminder",
          "action": "Update a reminder"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the reminder with",
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Frequency Type",
      "name": "frequencyType",
      "type": "options",
      "default": "one_time",
      "description": "Type of frequency of the reminder",
      "options": [
        {
          "name": "Once",
          "value": "one_time"
        },
        {
          "name": "Weekly",
          "value": "week"
        },
        {
          "name": "Monthly",
          "value": "month"
        },
        {
          "name": "Yearly",
          "value": "year"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Recurring Interval",
      "name": "frequencyNumber",
      "type": "number",
      "default": 0,
      "description": "Interval for the reminder",
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "create"
          ],
          "frequencyType": [
            "week",
            "month",
            "year"
          ]
        }
      }
    },
    {
      "displayName": "Initial Date",
      "name": "initialDate",
      "type": "dateTime",
      "default": "",
      "description": "Date of the reminder",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the reminder - max 100,000 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description about the reminder - Max 100,000 characters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Reminder ID",
      "name": "reminderId",
      "type": "string",
      "default": "",
      "description": "ID of the reminder to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Reminder ID",
      "name": "reminderId",
      "type": "string",
      "default": "",
      "description": "ID of the reminder to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Reminder ID",
      "name": "reminderId",
      "type": "string",
      "default": "",
      "description": "ID of the reminder to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Contact ID",
          "name": "contact_id",
          "type": "string",
          "default": "",
          "description": "ID of the contact to associate the reminder with"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description about the reminder - Max 100,000 characters"
        },
        {
          "displayName": "Frequency Type",
          "name": "frequency_type",
          "description": "Frequency of the reminder",
          "type": "options",
          "default": "one_time",
          "options": [
            {
              "name": "One Time",
              "value": "one_time"
            },
            {
              "name": "Week",
              "value": "week"
            },
            {
              "name": "Month",
              "value": "month"
            },
            {
              "name": "Year",
              "value": "year"
            }
          ]
        },
        {
          "displayName": "Initial Date",
          "name": "initial_data",
          "description": "Date of the reminder",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Recurring Interval",
          "name": "frequency_number",
          "type": "number",
          "default": 0,
          "description": "Interval for the reminder",
          "displayOptions": {
            "show": {
              "frequency_type": [
                "week",
                "month",
                "year"
              ]
            }
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "description": "Title of the reminder - max 100,000 characters",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reminder"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a tag",
          "action": "Create a tag"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a tag",
          "action": "Delete a tag"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a tag",
          "action": "Get a tag"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many tags",
          "action": "Get many tags"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a tag",
          "action": "Update a tag"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the tag - max 250 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "description": "ID of the tag to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "description": "ID of the tag to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "description": "ID of the tag to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the tag - max 250 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a task",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a task",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many tasks",
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a task",
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact to associate the task with",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the task entry - max 250 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the task - max 100,000 characters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Contact ID",
          "name": "contactId",
          "description": "ID of the contact to associate the task with",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Completed",
          "name": "completed",
          "description": "Whether the task has been completed",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the task - max 100,000 characters"
        },
        {
          "displayName": "Title",
          "name": "title",
          "description": "Title of the task entry - max 250 characters",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an activity"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve an activity"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many activities"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity"
    }
  ]


node_type: nodes-base.moveBinaryData
package_name: n8n-nodes-base
display_name: Convert to/from binary data
description: Move data between binary and JSON properties
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 21:14:59
properties_schema:
  [
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "binaryToJson",
      "description": "From and to where data should be moved",
      "options": [
        {
          "name": "Binary to JSON",
          "value": "binaryToJson",
          "description": "Move data from Binary to JSON"
        },
        {
          "name": "JSON to Binary",
          "value": "jsonToBinary",
          "description": "Move data from JSON to Binary"
        }
      ]
    },
    {
      "displayName": "Set All Data",
      "name": "setAllData",
      "type": "boolean",
      "default": true,
      "description": "Whether all JSON data should be replaced with the data retrieved from binary key. Else the data will be written to a single key.",
      "displayOptions": {
        "show": {
          "mode": [
            "binaryToJson"
          ]
        }
      }
    },
    {
      "displayName": "Source Key",
      "name": "sourceKey",
      "type": "string",
      "default": "data",
      "description": "The name of the binary key to get data from. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.currentKey\".",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "binaryToJson"
          ]
        }
      }
    },
    {
      "displayName": "Destination Key",
      "name": "destinationKey",
      "type": "string",
      "default": "data",
      "description": "The name the JSON key to copy data to. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.newKey\".",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "binaryToJson"
          ],
          "setAllData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Convert All Data",
      "name": "convertAllData",
      "type": "boolean",
      "default": true,
      "description": "Whether all JSON data should be converted to binary. Else only the data of one key will be converted.",
      "displayOptions": {
        "show": {
          "mode": [
            "jsonToBinary"
          ]
        }
      }
    },
    {
      "displayName": "Source Key",
      "name": "sourceKey",
      "type": "string",
      "default": "data",
      "description": "The name of the JSON key to get data from. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.currentKey\".",
      "required": true,
      "displayOptions": {
        "show": {
          "convertAllData": [
            false
          ],
          "mode": [
            "jsonToBinary"
          ]
        }
      }
    },
    {
      "displayName": "Destination Key",
      "name": "destinationKey",
      "type": "string",
      "default": "data",
      "description": "The name the binary key to copy data to. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.newKey\".",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "jsonToBinary"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Add Byte Order Mark (BOM)",
          "name": "addBOM",
          "description": "Whether to add special marker at the start of your text file. This marker helps some programs understand how to read the file correctly.",
          "displayOptions": {
            "show": {
              "/mode": [
                "jsonToBinary"
              ],
              "encoding": [
                "utf8",
                "cesu8",
                "ucs2"
              ]
            }
          },
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Data Is Base64",
          "name": "dataIsBase64",
          "type": "boolean",
          "displayOptions": {
            "hide": {
              "useRawData": [
                true
              ]
            },
            "show": {
              "/mode": [
                "jsonToBinary"
              ],
              "/convertAllData": [
                false
              ]
            }
          },
          "default": false,
          "description": "Whether to keep the binary data as base64 string"
        },
        {
          "displayName": "Encoding",
          "name": "encoding",
          "type": "options",
          "options": [
            {
              "name": "armscii8",
              "value": "armscii8"
            },
            {
              "name": "ascii",
              "value": "ascii"
            },
            {
              "name": "base64",
              "value": "base64"
            },
            {
              "name": "big5hkscs",
              "value": "big5hkscs"
            },
            {
              "name": "binary",
              "value": "binary"
            },
            {
              "name": "cesu8",
              "value": "cesu8"
            },
            {
              "name": "cp1046",
              "value": "cp1046"
            },
            {
              "name": "cp1124",
              "value": "cp1124"
            },
            {
              "name": "cp1125",
              "value": "cp1125"
            },
            {
              "name": "cp1129",
              "value": "cp1129"
            },
            {
              "name": "cp1133",
              "value": "cp1133"
            },
            {
              "name": "cp1161",
              "value": "cp1161"
            },
            {
              "name": "cp1162",
              "value": "cp1162"
            },
            {
              "name": "cp1163",
              "value": "cp1163"
            },
            {
              "name": "cp437",
              "value": "cp437"
            },
            {
              "name": "cp720",
              "value": "cp720"
            },
            {
              "name": "cp737",
              "value": "cp737"
            },
            {
              "name": "cp775",
              "value": "cp775"
            },
            {
              "name": "cp808",
              "value": "cp808"
            },
            {
              "name": "cp850",
              "value": "cp850"
            },
            {
              "name": "cp852",
              "value": "cp852"
            },
            {
              "name": "cp855",
              "value": "cp855"
            },
            {
              "name": "cp856",
              "value": "cp856"
            },
            {
              "name": "cp857",
              "value": "cp857"
            },
            {
              "name": "cp858",
              "value": "cp858"
            },
            {
              "name": "cp860",
              "value": "cp860"
            },
            {
              "name": "cp861",
              "value": "cp861"
            },
            {
              "name": "cp862",
              "value": "cp862"
            },
            {
              "name": "cp863",
              "value": "cp863"
            },
            {
              "name": "cp864",
              "value": "cp864"
            },
            {
              "name": "cp865",
              "value": "cp865"
            },
            {
              "name": "cp866",
              "value": "cp866"
            },
            {
              "name": "cp869",
              "value": "cp869"
            },
            {
              "name": "cp922",
              "value": "cp922"
            },
            {
              "name": "cp936",
              "value": "cp936"
            },
            {
              "name": "cp949",
              "value": "cp949"
            },
            {
              "name": "cp950",
              "value": "cp950"
            },
            {
              "name": "eucjp",
              "value": "eucjp"
            },
            {
              "name": "gb18030",
              "value": "gb18030"
            },
            {
              "name": "gbk",
              "value": "gbk"
            },
            {
              "name": "georgianacademy",
              "value": "georgianacademy"
            },
            {
              "name": "georgianps",
              "value": "georgianps"
            },
            {
              "name": "hex",
              "value": "hex"
            },
            {
              "name": "hproman8",
              "value": "hproman8"
            },
            {
              "name": "iso646cn",
              "value": "iso646cn"
            },
            {
              "name": "iso646jp",
              "value": "iso646jp"
            },
            {
              "name": "iso88591",
              "value": "iso88591"
            },
            {
              "name": "iso885910",
              "value": "iso885910"
            },
            {
              "name": "iso885911",
              "value": "iso885911"
            },
            {
              "name": "iso885913",
              "value": "iso885913"
            },
            {
              "name": "iso885914",
              "value": "iso885914"
            },
            {
              "name": "iso885915",
              "value": "iso885915"
            },
            {
              "name": "iso885916",
              "value": "iso885916"
            },
            {
              "name": "iso88592",
              "value": "iso88592"
            },
            {
              "name": "iso88593",
              "value": "iso88593"
            },
            {
              "name": "iso88594",
              "value": "iso88594"
            },
            {
              "name": "iso88595",
              "value": "iso88595"
            },
            {
              "name": "iso88596",
              "value": "iso88596"
            },
            {
              "name": "iso88597",
              "value": "iso88597"
            },
            {
              "name": "iso88598",
              "value": "iso88598"
            },
            {
              "name": "iso88599",
              "value": "iso88599"
            },
            {
              "name": "koi8r",
              "value": "koi8r"
            },
            {
              "name": "koi8ru",
              "value": "koi8ru"
            },
            {
              "name": "koi8t",
              "value": "koi8t"
            },
            {
              "name": "koi8u",
              "value": "koi8u"
            },
            {
              "name": "maccenteuro",
              "value": "maccenteuro"
            },
            {
              "name": "maccroatian",
              "value": "maccroatian"
            },
            {
              "name": "maccyrillic",
              "value": "maccyrillic"
            },
            {
              "name": "macgreek",
              "value": "macgreek"
            },
            {
              "name": "maciceland",
              "value": "maciceland"
            },
            {
              "name": "macintosh",
              "value": "macintosh"
            },
            {
              "name": "macroman",
              "value": "macroman"
            },
            {
              "name": "macromania",
              "value": "macromania"
            },
            {
              "name": "macthai",
              "value": "macthai"
            },
            {
              "name": "macturkish",
              "value": "macturkish"
            },
            {
              "name": "macukraine",
              "value": "macukraine"
            },
            {
              "name": "mik",
              "value": "mik"
            },
            {
              "name": "pt154",
              "value": "pt154"
            },
            {
              "name": "rk1048",
              "value": "rk1048"
            },
            {
              "name": "shiftjis",
              "value": "shiftjis"
            },
            {
              "name": "tcvn",
              "value": "tcvn"
            },
            {
              "name": "tis620",
              "value": "tis620"
            },
            {
              "name": "ucs2",
              "value": "ucs2"
            },
            {
              "name": "utf16",
              "value": "utf16"
            },
            {
              "name": "utf16be",
              "value": "utf16be"
            },
            {
              "name": "utf32",
              "value": "utf32"
            },
            {
              "name": "utf32be",
              "value": "utf32be"
            },
            {
              "name": "utf32le",
              "value": "utf32le"
            },
            {
              "name": "utf7",
              "value": "utf7"
            },
            {
              "name": "utf7imap",
              "value": "utf7imap"
            },
            {
              "name": "utf8",
              "value": "utf8"
            },
            {
              "name": "viscii",
              "value": "viscii"
            },
            {
              "name": "windows1250",
              "value": "windows1250"
            },
            {
              "name": "windows1251",
              "value": "windows1251"
            },
            {
              "name": "windows1252",
              "value": "windows1252"
            },
            {
              "name": "windows1253",
              "value": "windows1253"
            },
            {
              "name": "windows1254",
              "value": "windows1254"
            },
            {
              "name": "windows1255",
              "value": "windows1255"
            },
            {
              "name": "windows1256",
              "value": "windows1256"
            },
            {
              "name": "windows1257",
              "value": "windows1257"
            },
            {
              "name": "windows1258",
              "value": "windows1258"
            },
            {
              "name": "windows874",
              "value": "windows874"
            }
          ],
          "displayOptions": {
            "show": {
              "/mode": [
                "binaryToJson",
                "jsonToBinary"
              ]
            }
          },
          "default": "utf8",
          "description": "Choose the character set to use to encode the data"
        },
        {
          "displayName": "Strip BOM",
          "name": "stripBOM",
          "displayOptions": {
            "show": {
              "/mode": [
                "binaryToJson"
              ],
              "encoding": [
                "utf8",
                "cesu8",
                "ucs2"
              ]
            }
          },
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/mode": [
                "jsonToBinary"
              ]
            }
          },
          "default": "",
          "placeholder": "example.json",
          "description": "The file name to set"
        },
        {
          "displayName": "JSON Parse",
          "name": "jsonParse",
          "type": "boolean",
          "displayOptions": {
            "hide": {
              "keepAsBase64": [
                true
              ]
            },
            "show": {
              "/mode": [
                "binaryToJson"
              ],
              "/setAllData": [
                false
              ]
            }
          },
          "default": false,
          "description": "Whether to run JSON parse on the data to get proper object data"
        },
        {
          "displayName": "Keep Source",
          "name": "keepSource",
          "type": "boolean",
          "default": false,
          "description": "Whether the source key should be kept. By default it will be deleted."
        },
        {
          "displayName": "Keep As Base64",
          "name": "keepAsBase64",
          "type": "boolean",
          "displayOptions": {
            "hide": {
              "jsonParse": [
                true
              ]
            },
            "show": {
              "/mode": [
                "binaryToJson"
              ],
              "/setAllData": [
                false
              ]
            }
          },
          "default": false,
          "description": "Whether to keep the binary data as base64 string"
        },
        {
          "displayName": "MIME Type",
          "name": "mimeType",
          "type": "string",
          "displayOptions": {
            "show": {
              "/mode": [
                "jsonToBinary"
              ]
            }
          },
          "default": "application/json",
          "placeholder": "application/json",
          "description": "The mime-type to set. By default will the mime-type for JSON be set."
        },
        {
          "displayName": "Use Raw Data",
          "name": "useRawData",
          "type": "boolean",
          "displayOptions": {
            "hide": {
              "dataIsBase64": [
                true
              ]
            },
            "show": {
              "/mode": [
                "jsonToBinary"
              ]
            }
          },
          "default": false,
          "description": "Whether to use data as is and do not JSON.stringify it"
        }
      ]
    }
  ]


node_type: nodes-base.mqtt
package_name: n8n-nodes-base
display_name: MQTT
description: Push messages to MQTT
category: input
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mqtt",
  "required": true,
  "testedBy": "mqttConnectionTest"
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MQTT node documentation
  description: Learn how to use the MQTT node in n8n. Follow technical documentation to integrate MQTT node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # MQTT node

  Use the MQTT node to automate work in MQTT, and integrate MQTT with other applications. n8n supports transporting messages with MQTT.

  On this page, you'll find a list of operations the MQTT node supports and links to more resources.

  /// note | Credentials
  Refer to [MQTT credentials](/integrations/builtin/credentials/mqtt.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  Use the MQTT node to send a message. You can set the message topic, and choose whether to send the node input data as part of the message.

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mqtt') ]]

  ## Related resources

  n8n provides a trigger node for MQTT. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.mqtttrigger.md).

  Refer to [MQTT's documentation](https://mqtt.org/getting-started/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [
    {
      "displayName": "Topic",
      "name": "topic",
      "type": "string",
      "default": "",
      "description": "The topic to publish to",
      "required": true
    },
    {
      "displayName": "Send Input Data",
      "name": "sendInputData",
      "type": "boolean",
      "default": true,
      "description": "Whether to send the data the node receives as JSON"
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The message to publish",
      "required": true,
      "displayOptions": {
        "show": {
          "sendInputData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "QoS",
          "name": "qos",
          "type": "options",
          "options": [
            {
              "name": "Received at Most Once",
              "value": 0
            },
            {
              "name": "Received at Least Once",
              "value": 1
            },
            {
              "name": "Exactly Once",
              "value": 2
            }
          ],
          "default": 0,
          "description": "QoS subscription level"
        },
        {
          "displayName": "Retain",
          "name": "retain",
          "type": "boolean",
          "default": false,
          "description": "Normally if a publisher publishes a message to a topic, and no one is subscribed to that topic the message is simply discarded by the broker. However the publisher can tell the broker to keep the last message on that topic by setting the retain flag to true."
        }
      ]
    }
  ]


node_type: nodes-base.mqttTrigger
package_name: n8n-nodes-base
display_name: MQTT Trigger
description: Listens to MQTT events
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mqtt",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MQTT Trigger node documentation
  description: Learn how to use the MQTT Trigger node in n8n. Follow technical documentation to integrate MQTT Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # MQTT Trigger node

  [MQTT](https://mqtt.org){:target=_blank .external-link} is an open OASIS and ISO standard lightweight, publish-subscribe network protocol that transports messages between devices.

  /// note | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/mqtt.md).
  ///

  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [MQTT Trigger integrations](https://n8n.io/integrations/mqtt-trigger/){:target=_blank .external-link} page.
  ///

properties_schema:
  [
    {
      "displayName": "Topics",
      "name": "topics",
      "type": "string",
      "default": "",
      "description": "Topics to subscribe to, multiple can be defined with comma. Wildcard characters are supported (+ - for single level and # - for multi level). By default all subscription used QoS=0. To set a different QoS, write the QoS desired after the topic preceded by a colom. For Example: topicA:1,topicB:2"
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "JSON Parse Body",
          "name": "jsonParseBody",
          "type": "boolean",
          "default": false,
          "description": "Whether to try parse the message to an object"
        },
        {
          "displayName": "Only Message",
          "name": "onlyMessage",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only the message property"
        },
        {
          "displayName": "Parallel Processing",
          "name": "parallelProcessing",
          "type": "boolean",
          "default": true,
          "description": "Whether to process messages in parallel or by keeping the message in order"
        }
      ]
    }
  ]


node_type: nodes-base.msg91
package_name: n8n-nodes-base
display_name: MSG91
description: Sends transactional SMS via MSG91
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "send",
  "name": "Send",
  "description": "Send SMS"
  }
  ]

credentials_required:
  [
  {
  "name": "msg91Api",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MSG91 node documentation
  description: Learn how to use the MSG91 node in n8n. Follow technical documentation to integrate MSG91 node into your workflows.
  contentType: [integration, reference]
  ---

  # MSG91 node

  Use the MSG91 node to automate work in MSG91, and integrate MSG91 with other applications. n8n supports sending SMS with MSG91.

  On this page, you'll find a list of operations the MSG91 node supports and links to more resources.

  /// note | Credentials
  Refer to [MSG91 credentials](/integrations/builtin/credentials/msg91.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * SMS
      * Send SMS

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'msg91') ]]

  ## Find your Sender ID

  1. Log in to your MSG91 dashboard.
  2. Select **Sender Id** in the left panel.
  3. If you don't already have one, select **Add Sender Id +**, fill in the details, and select **Save Sender Id**.

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "sms",
      "options": [
        {
          "name": "SMS",
          "value": "sms"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send SMS",
          "action": "Send an SMS"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sender ID",
      "name": "from",
      "type": "string",
      "default": "",
      "description": "The number from which to send the message",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms"
          ]
        }
      }
    },
    {
      "displayName": "To",
      "name": "to",
      "type": "string",
      "default": "",
      "description": "The number, with coutry code, to which to send the message",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The message to send",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mySql
package_name: n8n-nodes-base
display_name: MySQL
description: Get, add and update data in MySQL
category: input
development_style: programmatic
version: 2.4
credentials_required:
  [
  {
  "name": "mySql",
  "required": true,
  "testedBy": "mysqlConnectionTest"
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MySQL node documentation
  description: Learn how to use the MySQL node in n8n. Follow technical documentation to integrate MySQL node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # MySQL node

  Use the MySQL node to automate work in MySQL, and integrate MySQL with other applications. n8n has built-in support for a wide range of MySQL features, including executing an SQL query, as well as inserting, and updating rows in a database.

  On this page, you'll find a list of operations the MySQL node supports and links to more resources.

  /// note | Credentials
  Refer to [MySQL credentials](/integrations/builtin/credentials/mysql.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Delete
  * Execute SQL
  * Insert
  * Insert or Update
  * Select
  * Update

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mysql') ]]

  ## Related resources

  Refer to [MySQL's Connectors and APIs documentation](https://dev.mysql.com/doc/index-connectors.html){:target=_blank .external-link} for more information about the service.

  Refer to MySQL's [SELECT statement documentation](https://dev.mysql.com/doc/refman/8.4/en/select.html){:target=_blank .external-link} for more information on writing SQL queries.

  ## Use query parameters

  When creating a query to run on a MySQL database, you can use the **Query Parameters** field in the **Options** section to load data into the query. n8n sanitizes data in query parameters, which prevents SQL injection.

  For example, you want to find a person by their email address. Given the following input data:

  ```js
  [
      {
          "email": "alex@example.com",
          "name": "Alex",
          "age": 21 
      },
      {
          "email": "jamie@example.com",
          "name": "Jamie",
          "age": 33 
      }
  ]
  ```

  You can write a query like:

  ```sql
  SELECT * FROM $1:name WHERE email = $2;
  ```

  Then in **Query Parameters**, provide the field values to use. You can provide fixed values or expressions. For this example, use expressions so the node can pull the email address from each input item in turn:

  ```js
  // users is an example table name
  users, {{ $json.email }} 
  ```

  ## Common issues

  For common errors or issues and suggested resolution steps, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.mysql/common-issues.md).

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "hidden",
      "default": "database",
      "options": [
        {
          "name": "Database",
          "value": "database"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "insert",
      "options": [
        {
          "name": "Delete",
          "value": "deleteTable",
          "description": "Delete an entire table or rows in a table",
          "action": "Delete table or rows"
        },
        {
          "name": "Execute SQL",
          "value": "executeQuery",
          "description": "Execute an SQL query",
          "action": "Execute a SQL query"
        },
        {
          "name": "Insert",
          "value": "insert",
          "description": "Insert rows in a table",
          "action": "Insert rows in a table"
        },
        {
          "name": "Insert or Update",
          "value": "upsert",
          "description": "Insert or update rows in a table",
          "action": "Insert or update rows in a table"
        },
        {
          "name": "Select",
          "value": "select",
          "description": "Select rows from a table",
          "action": "Select rows from a table"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update rows in a table",
          "action": "Update rows in a table"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table",
      "name": "table",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The table you want to work on",
      "required": true,
      "displayOptions": {
        "hide": {
          "operation": [
            "executeQuery"
          ]
        }
      }
    },
    {
      "displayName": "Command",
      "name": "deleteCommand",
      "type": "options",
      "default": "truncate",
      "options": [
        {
          "name": "Truncate",
          "value": "truncate",
          "description": "Only removes the table's data and preserves the table's structure"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete the rows that match the 'Select Rows' conditions below. If no selection is made, all rows in the table are deleted."
        },
        {
          "name": "Drop",
          "value": "drop",
          "description": "Deletes the table's data and also the table's structure permanently"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "deleteTable"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Select Rows",
      "name": "where",
      "type": "fixedCollection",
      "default": {},
      "description": "If not set, all rows will be selected",
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Column",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
              "default": "",
              "placeholder": "e.g. ID",
              "typeOptions": {
                "loadOptionsMethod": "getColumns",
                "loadOptionsDependsOn": [
                  "schema.value",
                  "table.value"
                ]
              }
            },
            {
              "displayName": "Operator",
              "name": "condition",
              "type": "options",
              "description": "The operator to check the column against. When using 'LIKE' operator percent sign ( %) matches zero or more characters, underscore ( _ ) matches any single character.",
              "options": [
                {
                  "name": "Equal",
                  "value": "equal"
                },
                {
                  "name": "Not Equal",
                  "value": "!="
                },
                {
                  "name": "Like",
                  "value": "LIKE"
                },
                {
                  "name": "Greater Than",
                  "value": ">"
                },
                {
                  "name": "Less Than",
                  "value": "<"
                },
                {
                  "name": "Greater Than Or Equal",
                  "value": ">="
                },
                {
                  "name": "Less Than Or Equal",
                  "value": "<="
                },
                {
                  "name": "Is Null",
                  "value": "IS NULL"
                },
                {
                  "name": "Is Not Null",
                  "value": "IS NOT NULL"
                }
              ],
              "default": "equal"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "displayOptions": {
                "hide": {
                  "condition": [
                    "IS NULL",
                    "IS NOT NULL"
                  ]
                }
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "deleteCommand": [
            "delete"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "deleteTable"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Combine Conditions",
      "name": "combineConditions",
      "type": "options",
      "default": "AND",
      "description": "How to combine the conditions defined in \"Select Rows\": AND requires all conditions to be true, OR requires at least one condition to be true",
      "options": [
        {
          "name": "AND",
          "value": "AND",
          "description": "Only rows that meet all the conditions are selected"
        },
        {
          "name": "OR",
          "value": "OR",
          "description": "Rows that meet at least one condition are selected"
        }
      ],
      "displayOptions": {
        "show": {
          "deleteCommand": [
            "delete"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "deleteTable"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Connection Timeout",
          "name": "connectionTimeoutMillis",
          "type": "number",
          "default": 30,
          "description": "Number of milliseconds reserved for connecting to the database",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "Connections Limit",
          "name": "connectionLimit",
          "type": "number",
          "default": 10,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Maximum amount of connections to the database, setting high value can lead to performance issues and potential database crashes"
        },
        {
          "displayName": "Query Batching",
          "name": "queryBatching",
          "type": "options",
          "noDataExpression": true,
          "description": "The way queries should be sent to the database",
          "options": [
            {
              "name": "Single Query",
              "value": "single",
              "description": "A single query for all incoming items"
            },
            {
              "name": "Independently",
              "value": "independently",
              "description": "Execute one query per incoming item of the run"
            },
            {
              "name": "Transaction",
              "value": "transaction",
              "description": "Execute all queries in a transaction, if a failure occurs, all changes are rolled back"
            }
          ],
          "default": "single"
        },
        {
          "displayName": "Query Parameters",
          "name": "queryReplacement",
          "type": "string",
          "default": "",
          "placeholder": "e.g. value1,value2,value3",
          "description": "Comma-separated list of the values you want to use as query parameters. You can drag the values from the input panel on the left. <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mysql/\" target=\"_blank\">More info</a>",
          "hint": "Comma-separated list of values: reference them in your query as $1, $2, $3…",
          "displayOptions": {
            "show": {
              "/operation": [
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Columns",
          "name": "outputColumns",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getColumnsMultiOptions",
            "loadOptionsDependsOn": [
              "table.value"
            ]
          },
          "default": [],
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Large-Format Numbers As",
          "name": "largeNumbersOutput",
          "type": "options",
          "options": [
            {
              "name": "Numbers",
              "value": "numbers"
            },
            {
              "name": "Text",
              "value": "text",
              "description": "Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)"
            }
          ],
          "hint": "Applies to NUMERIC and BIGINT columns only",
          "default": "text",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Decimals as Numbers",
          "name": "decimalNumbers",
          "type": "boolean",
          "default": false,
          "description": "Whether to output DECIMAL types as numbers instead of strings",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "options": [
            {
              "name": "Low Prioirity",
              "value": "LOW_PRIORITY",
              "description": "Delays execution of the INSERT until no other clients are reading from the table"
            },
            {
              "name": "High Priority",
              "value": "HIGH_PRIORITY",
              "description": "Overrides the effect of the --low-priority-updates option if the server was started with that option. It also causes concurrent inserts not to be used."
            }
          ],
          "default": "LOW_PRIORITY",
          "description": "Ignore any ignorable errors that occur while executing the INSERT statement",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        },
        {
          "displayName": "Replace Empty Strings with NULL",
          "name": "replaceEmptyStrings",
          "type": "boolean",
          "default": false,
          "description": "Whether to replace empty strings with NULL in input, could be useful when data come from spreadsheet",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert",
                "update",
                "upsert",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Select Distinct",
          "name": "selectDistinct",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove these duplicate rows",
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Query Execution Details",
          "name": "detailedOutput",
          "type": "boolean",
          "default": false,
          "description": "Whether to show in output details of the ofexecuted query for each statement, or just confirmation of success"
        },
        {
          "displayName": "Skip on Conflict",
          "name": "skipOnConflict",
          "type": "boolean",
          "default": false,
          "description": "Whether to skip the row and do not throw error if a unique constraint or exclusion constraint is violated",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "deleteTable"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The SQL query to execute. You can use n8n expressions and $1, $2, $3, etc to refer to the 'Query Parameters' set in options below.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "executeQuery"
          ]
        }
      },
      "typeOptions": {
        "editor": "sqlEditor",
        "sqlDialect": "MySQL"
      },
      "noDataExpression": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Connection Timeout",
          "name": "connectionTimeoutMillis",
          "type": "number",
          "default": 30,
          "description": "Number of milliseconds reserved for connecting to the database",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "Connections Limit",
          "name": "connectionLimit",
          "type": "number",
          "default": 10,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Maximum amount of connections to the database, setting high value can lead to performance issues and potential database crashes"
        },
        {
          "displayName": "Query Batching",
          "name": "queryBatching",
          "type": "options",
          "noDataExpression": true,
          "description": "The way queries should be sent to the database",
          "options": [
            {
              "name": "Single Query",
              "value": "single",
              "description": "A single query for all incoming items"
            },
            {
              "name": "Independently",
              "value": "independently",
              "description": "Execute one query per incoming item of the run"
            },
            {
              "name": "Transaction",
              "value": "transaction",
              "description": "Execute all queries in a transaction, if a failure occurs, all changes are rolled back"
            }
          ],
          "default": "single"
        },
        {
          "displayName": "Query Parameters",
          "name": "queryReplacement",
          "type": "string",
          "default": "",
          "placeholder": "e.g. value1,value2,value3",
          "description": "Comma-separated list of the values you want to use as query parameters. You can drag the values from the input panel on the left. <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mysql/\" target=\"_blank\">More info</a>",
          "hint": "Comma-separated list of values: reference them in your query as $1, $2, $3…",
          "displayOptions": {
            "show": {
              "/operation": [
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Columns",
          "name": "outputColumns",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getColumnsMultiOptions",
            "loadOptionsDependsOn": [
              "table.value"
            ]
          },
          "default": [],
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Large-Format Numbers As",
          "name": "largeNumbersOutput",
          "type": "options",
          "options": [
            {
              "name": "Numbers",
              "value": "numbers"
            },
            {
              "name": "Text",
              "value": "text",
              "description": "Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)"
            }
          ],
          "hint": "Applies to NUMERIC and BIGINT columns only",
          "default": "text",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Decimals as Numbers",
          "name": "decimalNumbers",
          "type": "boolean",
          "default": false,
          "description": "Whether to output DECIMAL types as numbers instead of strings",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "options": [
            {
              "name": "Low Prioirity",
              "value": "LOW_PRIORITY",
              "description": "Delays execution of the INSERT until no other clients are reading from the table"
            },
            {
              "name": "High Priority",
              "value": "HIGH_PRIORITY",
              "description": "Overrides the effect of the --low-priority-updates option if the server was started with that option. It also causes concurrent inserts not to be used."
            }
          ],
          "default": "LOW_PRIORITY",
          "description": "Ignore any ignorable errors that occur while executing the INSERT statement",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        },
        {
          "displayName": "Replace Empty Strings with NULL",
          "name": "replaceEmptyStrings",
          "type": "boolean",
          "default": false,
          "description": "Whether to replace empty strings with NULL in input, could be useful when data come from spreadsheet",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert",
                "update",
                "upsert",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Select Distinct",
          "name": "selectDistinct",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove these duplicate rows",
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Query Execution Details",
          "name": "detailedOutput",
          "type": "boolean",
          "default": false,
          "description": "Whether to show in output details of the ofexecuted query for each statement, or just confirmation of success"
        },
        {
          "displayName": "Skip on Conflict",
          "name": "skipOnConflict",
          "type": "boolean",
          "default": false,
          "description": "Whether to skip the row and do not throw error if a unique constraint or exclusion constraint is violated",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "executeQuery"
          ]
        }
      }
    },
    {
      "displayName": "Data Mode",
      "name": "dataMode",
      "type": "options",
      "default": "autoMapInputData",
      "description": "Whether to map node input properties and the table data automatically or manually",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties names exactly match the table column names"
        },
        {
          "name": "Map Each Column Manually",
          "value": "defineBelow",
          "description": "Set the value for each destination column manually"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "insert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "\n\t\tIn this mode, make sure incoming data fields are named the same as the columns in your table. If needed, use an 'Edit Fields' node before this node to change the field names.\n\t\t",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "dataMode": [
            "autoMapInputData"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "insert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Values to Send",
      "name": "valuesToSend",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Column",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getColumns",
                "loadOptionsDependsOn": [
                  "table.value"
                ]
              },
              "default": []
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "dataMode": [
            "defineBelow"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "insert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Value",
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Connection Timeout",
          "name": "connectionTimeoutMillis",
          "type": "number",
          "default": 30,
          "description": "Number of milliseconds reserved for connecting to the database",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "Connections Limit",
          "name": "connectionLimit",
          "type": "number",
          "default": 10,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Maximum amount of connections to the database, setting high value can lead to performance issues and potential database crashes"
        },
        {
          "displayName": "Query Batching",
          "name": "queryBatching",
          "type": "options",
          "noDataExpression": true,
          "description": "The way queries should be sent to the database",
          "options": [
            {
              "name": "Single Query",
              "value": "single",
              "description": "A single query for all incoming items"
            },
            {
              "name": "Independently",
              "value": "independently",
              "description": "Execute one query per incoming item of the run"
            },
            {
              "name": "Transaction",
              "value": "transaction",
              "description": "Execute all queries in a transaction, if a failure occurs, all changes are rolled back"
            }
          ],
          "default": "single"
        },
        {
          "displayName": "Query Parameters",
          "name": "queryReplacement",
          "type": "string",
          "default": "",
          "placeholder": "e.g. value1,value2,value3",
          "description": "Comma-separated list of the values you want to use as query parameters. You can drag the values from the input panel on the left. <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mysql/\" target=\"_blank\">More info</a>",
          "hint": "Comma-separated list of values: reference them in your query as $1, $2, $3…",
          "displayOptions": {
            "show": {
              "/operation": [
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Columns",
          "name": "outputColumns",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getColumnsMultiOptions",
            "loadOptionsDependsOn": [
              "table.value"
            ]
          },
          "default": [],
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Large-Format Numbers As",
          "name": "largeNumbersOutput",
          "type": "options",
          "options": [
            {
              "name": "Numbers",
              "value": "numbers"
            },
            {
              "name": "Text",
              "value": "text",
              "description": "Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)"
            }
          ],
          "hint": "Applies to NUMERIC and BIGINT columns only",
          "default": "text",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Decimals as Numbers",
          "name": "decimalNumbers",
          "type": "boolean",
          "default": false,
          "description": "Whether to output DECIMAL types as numbers instead of strings",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "options": [
            {
              "name": "Low Prioirity",
              "value": "LOW_PRIORITY",
              "description": "Delays execution of the INSERT until no other clients are reading from the table"
            },
            {
              "name": "High Priority",
              "value": "HIGH_PRIORITY",
              "description": "Overrides the effect of the --low-priority-updates option if the server was started with that option. It also causes concurrent inserts not to be used."
            }
          ],
          "default": "LOW_PRIORITY",
          "description": "Ignore any ignorable errors that occur while executing the INSERT statement",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        },
        {
          "displayName": "Replace Empty Strings with NULL",
          "name": "replaceEmptyStrings",
          "type": "boolean",
          "default": false,
          "description": "Whether to replace empty strings with NULL in input, could be useful when data come from spreadsheet",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert",
                "update",
                "upsert",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Select Distinct",
          "name": "selectDistinct",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove these duplicate rows",
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Query Execution Details",
          "name": "detailedOutput",
          "type": "boolean",
          "default": false,
          "description": "Whether to show in output details of the ofexecuted query for each statement, or just confirmation of success"
        },
        {
          "displayName": "Skip on Conflict",
          "name": "skipOnConflict",
          "type": "boolean",
          "default": false,
          "description": "Whether to skip the row and do not throw error if a unique constraint or exclusion constraint is violated",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "insert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "select"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "select"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Select Rows",
      "name": "where",
      "type": "fixedCollection",
      "default": {},
      "description": "If not set, all rows will be selected",
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Column",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
              "default": "",
              "placeholder": "e.g. ID",
              "typeOptions": {
                "loadOptionsMethod": "getColumns",
                "loadOptionsDependsOn": [
                  "schema.value",
                  "table.value"
                ]
              }
            },
            {
              "displayName": "Operator",
              "name": "condition",
              "type": "options",
              "description": "The operator to check the column against. When using 'LIKE' operator percent sign ( %) matches zero or more characters, underscore ( _ ) matches any single character.",
              "options": [
                {
                  "name": "Equal",
                  "value": "equal"
                },
                {
                  "name": "Not Equal",
                  "value": "!="
                },
                {
                  "name": "Like",
                  "value": "LIKE"
                },
                {
                  "name": "Greater Than",
                  "value": ">"
                },
                {
                  "name": "Less Than",
                  "value": "<"
                },
                {
                  "name": "Greater Than Or Equal",
                  "value": ">="
                },
                {
                  "name": "Less Than Or Equal",
                  "value": "<="
                },
                {
                  "name": "Is Null",
                  "value": "IS NULL"
                },
                {
                  "name": "Is Not Null",
                  "value": "IS NOT NULL"
                }
              ],
              "default": "equal"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "displayOptions": {
                "hide": {
                  "condition": [
                    "IS NULL",
                    "IS NOT NULL"
                  ]
                }
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "select"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Combine Conditions",
      "name": "combineConditions",
      "type": "options",
      "default": "AND",
      "description": "How to combine the conditions defined in \"Select Rows\": AND requires all conditions to be true, OR requires at least one condition to be true",
      "options": [
        {
          "name": "AND",
          "value": "AND",
          "description": "Only rows that meet all the conditions are selected"
        },
        {
          "name": "OR",
          "value": "OR",
          "description": "Rows that meet at least one condition are selected"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "select"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Sort",
      "name": "sort",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Column",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
              "default": "",
              "typeOptions": {
                "loadOptionsMethod": "getColumns",
                "loadOptionsDependsOn": [
                  "schema.value",
                  "table.value"
                ]
              }
            },
            {
              "displayName": "Direction",
              "name": "direction",
              "type": "options",
              "options": [
                {
                  "name": "ASC",
                  "value": "ASC"
                },
                {
                  "name": "DESC",
                  "value": "DESC"
                }
              ],
              "default": "ASC"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "select"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Connection Timeout",
          "name": "connectionTimeoutMillis",
          "type": "number",
          "default": 30,
          "description": "Number of milliseconds reserved for connecting to the database",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "Connections Limit",
          "name": "connectionLimit",
          "type": "number",
          "default": 10,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Maximum amount of connections to the database, setting high value can lead to performance issues and potential database crashes"
        },
        {
          "displayName": "Query Batching",
          "name": "queryBatching",
          "type": "options",
          "noDataExpression": true,
          "description": "The way queries should be sent to the database",
          "options": [
            {
              "name": "Single Query",
              "value": "single",
              "description": "A single query for all incoming items"
            },
            {
              "name": "Independently",
              "value": "independently",
              "description": "Execute one query per incoming item of the run"
            },
            {
              "name": "Transaction",
              "value": "transaction",
              "description": "Execute all queries in a transaction, if a failure occurs, all changes are rolled back"
            }
          ],
          "default": "single"
        },
        {
          "displayName": "Query Parameters",
          "name": "queryReplacement",
          "type": "string",
          "default": "",
          "placeholder": "e.g. value1,value2,value3",
          "description": "Comma-separated list of the values you want to use as query parameters. You can drag the values from the input panel on the left. <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mysql/\" target=\"_blank\">More info</a>",
          "hint": "Comma-separated list of values: reference them in your query as $1, $2, $3…",
          "displayOptions": {
            "show": {
              "/operation": [
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Columns",
          "name": "outputColumns",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getColumnsMultiOptions",
            "loadOptionsDependsOn": [
              "table.value"
            ]
          },
          "default": [],
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Large-Format Numbers As",
          "name": "largeNumbersOutput",
          "type": "options",
          "options": [
            {
              "name": "Numbers",
              "value": "numbers"
            },
            {
              "name": "Text",
              "value": "text",
              "description": "Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)"
            }
          ],
          "hint": "Applies to NUMERIC and BIGINT columns only",
          "default": "text",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Decimals as Numbers",
          "name": "decimalNumbers",
          "type": "boolean",
          "default": false,
          "description": "Whether to output DECIMAL types as numbers instead of strings",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "options": [
            {
              "name": "Low Prioirity",
              "value": "LOW_PRIORITY",
              "description": "Delays execution of the INSERT until no other clients are reading from the table"
            },
            {
              "name": "High Priority",
              "value": "HIGH_PRIORITY",
              "description": "Overrides the effect of the --low-priority-updates option if the server was started with that option. It also causes concurrent inserts not to be used."
            }
          ],
          "default": "LOW_PRIORITY",
          "description": "Ignore any ignorable errors that occur while executing the INSERT statement",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        },
        {
          "displayName": "Replace Empty Strings with NULL",
          "name": "replaceEmptyStrings",
          "type": "boolean",
          "default": false,
          "description": "Whether to replace empty strings with NULL in input, could be useful when data come from spreadsheet",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert",
                "update",
                "upsert",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Select Distinct",
          "name": "selectDistinct",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove these duplicate rows",
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Query Execution Details",
          "name": "detailedOutput",
          "type": "boolean",
          "default": false,
          "description": "Whether to show in output details of the ofexecuted query for each statement, or just confirmation of success"
        },
        {
          "displayName": "Skip on Conflict",
          "name": "skipOnConflict",
          "type": "boolean",
          "default": false,
          "description": "Whether to skip the row and do not throw error if a unique constraint or exclusion constraint is violated",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "select"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Data Mode",
      "name": "dataMode",
      "type": "options",
      "default": "autoMapInputData",
      "description": "Whether to map node input properties and the table data automatically or manually",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties names exactly match the table column names"
        },
        {
          "name": "Map Each Column Below",
          "value": "defineBelow",
          "description": "Set the value for each destination column manually"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "\n\t\tIn this mode, make sure incoming data fields are named the same as the columns in your table. If needed, use an 'Edit Fields' node before this node to change the field names.\n\t\t",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "dataMode": [
            "autoMapInputData"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Column to Match On",
      "name": "columnToMatchOn",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getColumns",
        "loadOptionsDependsOn": [
          "schema.value",
          "table.value"
        ]
      }
    },
    {
      "displayName": "Value of Column to Match On",
      "name": "valueToMatchOn",
      "type": "string",
      "default": "",
      "description": "Rows with a value in the specified \"Column to Match On\" that corresponds to the value in this field will be updated",
      "displayOptions": {
        "show": {
          "dataMode": [
            "defineBelow"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Values to Send",
      "name": "valuesToSend",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Column",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getColumnsWithoutColumnToMatchOn",
                "loadOptionsDependsOn": [
                  "schema.value",
                  "table.value"
                ]
              },
              "default": []
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "dataMode": [
            "defineBelow"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Value",
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Connection Timeout",
          "name": "connectionTimeoutMillis",
          "type": "number",
          "default": 30,
          "description": "Number of milliseconds reserved for connecting to the database",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "Connections Limit",
          "name": "connectionLimit",
          "type": "number",
          "default": 10,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Maximum amount of connections to the database, setting high value can lead to performance issues and potential database crashes"
        },
        {
          "displayName": "Query Batching",
          "name": "queryBatching",
          "type": "options",
          "noDataExpression": true,
          "description": "The way queries should be sent to the database",
          "options": [
            {
              "name": "Single Query",
              "value": "single",
              "description": "A single query for all incoming items"
            },
            {
              "name": "Independently",
              "value": "independently",
              "description": "Execute one query per incoming item of the run"
            },
            {
              "name": "Transaction",
              "value": "transaction",
              "description": "Execute all queries in a transaction, if a failure occurs, all changes are rolled back"
            }
          ],
          "default": "single"
        },
        {
          "displayName": "Query Parameters",
          "name": "queryReplacement",
          "type": "string",
          "default": "",
          "placeholder": "e.g. value1,value2,value3",
          "description": "Comma-separated list of the values you want to use as query parameters. You can drag the values from the input panel on the left. <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mysql/\" target=\"_blank\">More info</a>",
          "hint": "Comma-separated list of values: reference them in your query as $1, $2, $3…",
          "displayOptions": {
            "show": {
              "/operation": [
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Columns",
          "name": "outputColumns",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getColumnsMultiOptions",
            "loadOptionsDependsOn": [
              "table.value"
            ]
          },
          "default": [],
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Large-Format Numbers As",
          "name": "largeNumbersOutput",
          "type": "options",
          "options": [
            {
              "name": "Numbers",
              "value": "numbers"
            },
            {
              "name": "Text",
              "value": "text",
              "description": "Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)"
            }
          ],
          "hint": "Applies to NUMERIC and BIGINT columns only",
          "default": "text",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Decimals as Numbers",
          "name": "decimalNumbers",
          "type": "boolean",
          "default": false,
          "description": "Whether to output DECIMAL types as numbers instead of strings",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "options": [
            {
              "name": "Low Prioirity",
              "value": "LOW_PRIORITY",
              "description": "Delays execution of the INSERT until no other clients are reading from the table"
            },
            {
              "name": "High Priority",
              "value": "HIGH_PRIORITY",
              "description": "Overrides the effect of the --low-priority-updates option if the server was started with that option. It also causes concurrent inserts not to be used."
            }
          ],
          "default": "LOW_PRIORITY",
          "description": "Ignore any ignorable errors that occur while executing the INSERT statement",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        },
        {
          "displayName": "Replace Empty Strings with NULL",
          "name": "replaceEmptyStrings",
          "type": "boolean",
          "default": false,
          "description": "Whether to replace empty strings with NULL in input, could be useful when data come from spreadsheet",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert",
                "update",
                "upsert",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Select Distinct",
          "name": "selectDistinct",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove these duplicate rows",
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Query Execution Details",
          "name": "detailedOutput",
          "type": "boolean",
          "default": false,
          "description": "Whether to show in output details of the ofexecuted query for each statement, or just confirmation of success"
        },
        {
          "displayName": "Skip on Conflict",
          "name": "skipOnConflict",
          "type": "boolean",
          "default": false,
          "description": "Whether to skip the row and do not throw error if a unique constraint or exclusion constraint is violated",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Data Mode",
      "name": "dataMode",
      "type": "options",
      "default": "autoMapInputData",
      "description": "Whether to map node input properties and the table data automatically or manually",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties names exactly match the table column names"
        },
        {
          "name": "Map Each Column Below",
          "value": "defineBelow",
          "description": "Set the value for each destination column manually"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "upsert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "\n\t\tIn this mode, make sure incoming data fields are named the same as the columns in your table. If needed, use an 'Edit Fields' node before this node to change the field names.\n\t\t",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "dataMode": [
            "autoMapInputData"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "upsert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Column to Match On",
      "name": "columnToMatchOn",
      "type": "options",
      "default": "",
      "description": "The column to compare when finding the rows to update. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "upsert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getColumns",
        "loadOptionsDependsOn": [
          "schema.value",
          "table.value"
        ]
      }
    },
    {
      "displayName": "Value of Column to Match On",
      "name": "valueToMatchOn",
      "type": "string",
      "default": "",
      "description": "Rows with a value in the specified \"Column to Match On\" that corresponds to the value in this field will be updated. New rows will be created for non-matching items.",
      "displayOptions": {
        "show": {
          "dataMode": [
            "defineBelow"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "upsert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Values to Send",
      "name": "valuesToSend",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Column",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getColumnsWithoutColumnToMatchOn",
                "loadOptionsDependsOn": [
                  "schema.value",
                  "table.value"
                ]
              },
              "default": []
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "dataMode": [
            "defineBelow"
          ],
          "resource": [
            "database"
          ],
          "operation": [
            "upsert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Value",
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Connection Timeout",
          "name": "connectionTimeoutMillis",
          "type": "number",
          "default": 30,
          "description": "Number of milliseconds reserved for connecting to the database",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "Connections Limit",
          "name": "connectionLimit",
          "type": "number",
          "default": 10,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Maximum amount of connections to the database, setting high value can lead to performance issues and potential database crashes"
        },
        {
          "displayName": "Query Batching",
          "name": "queryBatching",
          "type": "options",
          "noDataExpression": true,
          "description": "The way queries should be sent to the database",
          "options": [
            {
              "name": "Single Query",
              "value": "single",
              "description": "A single query for all incoming items"
            },
            {
              "name": "Independently",
              "value": "independently",
              "description": "Execute one query per incoming item of the run"
            },
            {
              "name": "Transaction",
              "value": "transaction",
              "description": "Execute all queries in a transaction, if a failure occurs, all changes are rolled back"
            }
          ],
          "default": "single"
        },
        {
          "displayName": "Query Parameters",
          "name": "queryReplacement",
          "type": "string",
          "default": "",
          "placeholder": "e.g. value1,value2,value3",
          "description": "Comma-separated list of the values you want to use as query parameters. You can drag the values from the input panel on the left. <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mysql/\" target=\"_blank\">More info</a>",
          "hint": "Comma-separated list of values: reference them in your query as $1, $2, $3…",
          "displayOptions": {
            "show": {
              "/operation": [
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Columns",
          "name": "outputColumns",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\" target=\"_blank\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getColumnsMultiOptions",
            "loadOptionsDependsOn": [
              "table.value"
            ]
          },
          "default": [],
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Large-Format Numbers As",
          "name": "largeNumbersOutput",
          "type": "options",
          "options": [
            {
              "name": "Numbers",
              "value": "numbers"
            },
            {
              "name": "Text",
              "value": "text",
              "description": "Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)"
            }
          ],
          "hint": "Applies to NUMERIC and BIGINT columns only",
          "default": "text",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Output Decimals as Numbers",
          "name": "decimalNumbers",
          "type": "boolean",
          "default": false,
          "description": "Whether to output DECIMAL types as numbers instead of strings",
          "displayOptions": {
            "show": {
              "/operation": [
                "select",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "options": [
            {
              "name": "Low Prioirity",
              "value": "LOW_PRIORITY",
              "description": "Delays execution of the INSERT until no other clients are reading from the table"
            },
            {
              "name": "High Priority",
              "value": "HIGH_PRIORITY",
              "description": "Overrides the effect of the --low-priority-updates option if the server was started with that option. It also causes concurrent inserts not to be used."
            }
          ],
          "default": "LOW_PRIORITY",
          "description": "Ignore any ignorable errors that occur while executing the INSERT statement",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        },
        {
          "displayName": "Replace Empty Strings with NULL",
          "name": "replaceEmptyStrings",
          "type": "boolean",
          "default": false,
          "description": "Whether to replace empty strings with NULL in input, could be useful when data come from spreadsheet",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert",
                "update",
                "upsert",
                "executeQuery"
              ]
            }
          }
        },
        {
          "displayName": "Select Distinct",
          "name": "selectDistinct",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove these duplicate rows",
          "displayOptions": {
            "show": {
              "/operation": [
                "select"
              ]
            }
          }
        },
        {
          "displayName": "Output Query Execution Details",
          "name": "detailedOutput",
          "type": "boolean",
          "default": false,
          "description": "Whether to show in output details of the ofexecuted query for each statement, or just confirmation of success"
        },
        {
          "displayName": "Skip on Conflict",
          "name": "skipOnConflict",
          "type": "boolean",
          "default": false,
          "description": "Whether to skip the row and do not throw error if a unique constraint or exclusion constraint is violated",
          "displayOptions": {
            "show": {
              "/operation": [
                "insert"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "database"
          ],
          "operation": [
            "upsert"
          ]
        },
        "hide": {
          "table": [
            ""
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "deleteTable",
      "name": "Delete",
      "description": "Delete an entire table or rows in a table"
    },
    {
      "operation": "executeQuery",
      "name": "Execute SQL",
      "description": "Execute an SQL query"
    },
    {
      "operation": "insert",
      "name": "Insert",
      "description": "Insert rows in a table"
    },
    {
      "operation": "upsert",
      "name": "Insert or Update",
      "description": "Insert or update rows in a table"
    },
    {
      "operation": "select",
      "name": "Select",
      "description": "Select rows from a table"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update rows in a table"
    }
  ]


node_type: nodes-base.n8n
package_name: n8n-nodes-base
display_name: n8n
description: Handle events and perform actions on your n8n instance
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "n8nApi",
  "required": true
  }
  ]

updated_at: 2025-06-12 21:14:59
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: n8n
  description: Documentation for the n8n node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # n8n

  A node to integrate with n8n itself. This node allows you to consume the [n8n API](/api/index.md) in your workflows.

  Refer to the [n8n REST API documentation](/api/index.md) for more information on using the n8n API. Refer to [API endpoint reference](/api/api-reference.md) for working with the API endpoints directly.

  /// note | Credentials
  You can find authentication information for this node in the [API authentication](/api/authentication.md) documentation.
  ///

  /// warning | SSL
  This node doesn't support SSL. If your server requires an SSL connection, use the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to call the [n8n API](/api/index.md).
  The HTTP Request node has options to [provide the SSL certificate](/integrations/builtin/credentials/httprequest.md#provide-an-ssl-certificate).
  ///

  ## Operations

  * Audit
  	* [**Generate** a security audit](#generate-audit)
  * Credential
  	* [**Create** a credential](#create-credential)
  	* [**Delete** a credential](#delete-credential)
  	* [**Get Schema**](#get-credential-schema): Use this operation to get credential data schema for type
  * Execution
  	* [**Get** an execution](#get-execution)
  	* [**Get Many** executions](#get-many-executions)
  	* [**Delete** an execution](#delete-execution)
  * Workflow
  	* [**Activate** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Create** a workflow](#create-workflow)
  	* [**Deactivate** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Delete** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Get** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Get Many** workflows](#get-many-workflows)
  	* [**Update** a workflow](#update-workflow)

  ## Generate audit

  This operation has no parameters. Configure it with these options:

  * **Categories**: Select the risk categories you want the audit to include. Options include:
  	* **Credentials**
  	* **Database**
  	* **Filesystem**
  	* **Instance**
  	* **Nodes**
  * **Days Abandoned Workflow**: Use this option to set the number of days without execution after which a workflow should be considered abandoned. Enter a number of days. The default is `90`.

  ## Create credential

  Configure this operation with these parameters:

  * **Name**: Enter the name of the credential you'd like to create.
  * **Credential Type**: Enter the credential's type. The available types depend on nodes installed on the n8n instance. Some built-in types include `githubApi`, `notionApi`, and `slackApi`.
  * **Data**: Enter a valid JSON object with the required properties for this **Credential Type**. To see the expected format, use the **Get Schema** operation.

  ## Delete credential

  Configure this operation with this parameter:

  * **Credential ID**: Enter the ID of the credential you want to delete.

  ## Get credential schema

  Configure this operation with this parameter:

  * **Credential Type**: Enter the credential's type. The available types depend on nodes installed on the n8n instance. Some built-in types include `githubApi`, `notionApi`, and `slackApi`.

  ## Get execution

  Configure this operation with this parameter:

  * **Execution ID**: Enter the ID of the execution you want to retrieve.

  ### Get execution option

  You can further configure this operation with this **Option**:

  * **Include Execution Details**: Use this control to set whether to include the detailed execution data (turned on) or not (turned off).

  ## Get many executions

  Configure this operation with these parameters:

  * **Return All**: Set whether to return all results (turned on) or whether to limit the results to the entered **Limit** (turned on).
  * **Limit**: Set the number of results to return if the **Return All** control is turned off.

  ### Get many executions filters

  You can further configure this operation with these **Filters**:

  * **Workflow**: Filter the executions by workflow. Options include:
  	* **From list**: Select a workflow to use as a filter.
  	* **By URL**: Enter a workflow URL to use as a filter.
  	* **By ID**: Enter a workflow ID to use as a filter.
  * **Status**: Filter the executions by status. Options include:
  	* **Error**
  	* **Success**
  	* **Waiting**

  ### Get many execution options

  You can further configure this operation with this **Option**:

  * **Include Execution Details**: Use this control to set whether to include the detailed execution data (turned on) or not (turned off).

  ## Delete execution

  Configure this operation with this parameter:

  * **Execution ID**: Enter the ID of the execution you want to delete.

  ## Activate, deactivate, delete, and get workflow

  The **Activate**, **Deactivate**, **Delete**, and **Get** workflow operations all include the same parameter for you to select the **Workflow** you want to perform the operation on. Options include:

  * **From list**: Select the workflow from the list.
  * **By URL**: Enter the URL of the workflow.
  * **By ID**: Enter the ID of the workflow.

  ## Create workflow

  Configure this operation with this parameter:

  * **Workflow Object**: Enter a valid JSON object with the new workflow's details. The object requires these fields:
  	* `name`
  	* `nodes`
  	* `connections`
  	* `settings`

  Refer to the [n8n API | Create a workflow documentation](/api/api-reference.md/#tag/Workflow/paths/~1workflows/post) for more information.

  ## Get many workflows

  Configure this operation with these parameters:

  * **Return All**: Set whether to return all results (turned on) or whether to limit the results to the entered **Limit** (turned on).
  * **Limit**: Set the number of results to return if the **Return All** control is turned off.

  ### Get many workflows filters

  You can further configure this operation with these **Filters**:

  * **Return Only Active Workflows**: Select whether to return only active workflows (turned on) or active and inactive workflows (turned off).
  * **Tags**: Enter a comma-separated list of tags the returned workflows must have.

  ## Update workflow

  Configure this operation with these parameters:

  * **Workflow**: Select the workflow you want to update. Options include:
  	* **From list**: Select the workflow from the list.
  	* **By URL**: Enter the URL of the workflow.
  	* **By ID**: Enter the ID of the workflow.
  * **Workflow Object**: Enter a valid JSON object to update the workflow with. The object requires these fields:
  	* `name`
  	* `nodes`
  	* `connections`
  	* `settings`

  Refer to the [n8n API | Update a workflow documentation](https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows~1%7Bid%7D/put) for more information.

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'n8n') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "workflow",
      "options": [
        {
          "name": "Audit",
          "value": "audit"
        },
        {
          "name": "Credential",
          "value": "credential"
        },
        {
          "name": "Execution",
          "value": "execution"
        },
        {
          "name": "Workflow",
          "value": "workflow"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Generate",
          "value": "generate",
          "action": "Generate a security audit",
          "description": "Generate a security audit for this n8n instance",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/audit"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "audit"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Categories",
          "name": "categories",
          "description": "Risk categories to include in the audit",
          "type": "multiOptions",
          "default": [],
          "options": [
            {
              "name": "Credentials",
              "value": "credentials"
            },
            {
              "name": "Database",
              "value": "database"
            },
            {
              "name": "Filesystem",
              "value": "filesystem"
            },
            {
              "name": "Instance",
              "value": "instance"
            },
            {
              "name": "Nodes",
              "value": "nodes"
            }
          ]
        },
        {
          "displayName": "Days Abandoned Workflow",
          "name": "daysAbandonedWorkflow",
          "description": "Days for a workflow to be considered abandoned if not executed",
          "type": "number",
          "default": 90
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "audit"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a credential",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/credentials"
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a credential",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/credentials/{{ $parameter.credentialId }}"
            }
          }
        },
        {
          "name": "Get Schema",
          "value": "getSchema",
          "action": "Get credential data schema for type",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/credentials/schema/{{ $parameter.credentialTypeName }}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "credential"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the new credential",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "credential"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Credential Type",
      "name": "credentialTypeName",
      "type": "string",
      "default": "",
      "description": "The available types depend on nodes installed on the n8n instance. Some built-in types include e.g. 'githubApi', 'notionApi', and 'slackApi'.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "credential"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "data",
      "type": "json",
      "default": "",
      "description": "A valid JSON object with properties required for this Credential Type. To see the expected format, you can use 'Get Schema' operation.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "credential"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Credential ID",
      "name": "credentialId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "credential"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Credential Type",
      "name": "credentialTypeName",
      "type": "string",
      "default": "",
      "description": "The available types depend on nodes installed on the n8n instance. Some built-in types include e.g. 'githubApi', 'notionApi', and 'slackApi'.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "credential"
          ],
          "operation": [
            "getSchema"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an execution",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/executions/{{ $parameter.executionId }}"
            }
          }
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many executions",
          "routing": {
            "request": {
              "method": "GET",
              "url": "/executions"
            },
            "send": {
              "paginate": true
            },
            "operations": {}
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an execution",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/executions/{{ $parameter.executionId }}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Execution ID",
      "name": "executionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Workflow",
          "name": "workflowId",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "description": "Workflow to filter the executions by",
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select a Workflow...",
              "initType": "workflow",
              "typeOptions": {
                "searchListMethod": "searchWorkflows",
                "searchFilterRequired": false,
                "searchable": true
              }
            },
            {
              "displayName": "By URL",
              "name": "url",
              "type": "string",
              "placeholder": "https://myinstance.app.n8n.cloud/workflow/1",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": ".*/workflow/([0-9a-zA-Z]{1,})",
                    "errorMessage": "Not a valid Workflow URL"
                  }
                }
              ],
              "extractValue": {
                "type": "regex",
                "regex": ".*/workflow/([0-9a-zA-Z]{1,})"
              }
            },
            {
              "displayName": "ID",
              "name": "id",
              "type": "string",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": "[0-9a-zA-Z]{1,}",
                    "errorMessage": "Not a valid Workflow ID"
                  }
                }
              ],
              "placeholder": "1"
            }
          ],
          "routing": {
            "send": {
              "type": "query",
              "property": "workflowId",
              "value": "={{ $value || undefined }}"
            }
          }
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Error",
              "value": "error"
            },
            {
              "name": "Success",
              "value": "success"
            },
            {
              "name": "Waiting",
              "value": "waiting"
            }
          ],
          "default": "success",
          "routing": {
            "send": {
              "type": "query",
              "property": "status",
              "value": "={{ $value }}"
            }
          },
          "description": "Status to filter the executions by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Execution Details",
          "name": "activeWorkflows",
          "type": "boolean",
          "default": false,
          "routing": {
            "send": {
              "type": "query",
              "property": "includeData",
              "value": "={{ $value }}"
            }
          },
          "description": "Whether to include the detailed execution data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Execution ID",
      "name": "executionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Execution Details",
          "name": "activeWorkflows",
          "type": "boolean",
          "default": false,
          "routing": {
            "send": {
              "type": "query",
              "property": "includeData",
              "value": "={{ $value }}"
            }
          },
          "description": "Whether to include the detailed execution data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "execution"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Activate",
          "value": "activate",
          "action": "Activate a workflow"
        },
        {
          "name": "Create",
          "value": "create",
          "action": "Create a workflow",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/workflows"
            }
          }
        },
        {
          "name": "Deactivate",
          "value": "deactivate",
          "action": "Deactivate a workflow"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a workflow"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a workflow"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many workflows",
          "routing": {
            "request": {
              "method": "GET",
              "url": "/workflows"
            },
            "send": {
              "paginate": true
            },
            "operations": {}
          }
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a workflow"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Workflow",
      "name": "workflowId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Workflow to filter the executions by",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "activate"
          ]
        }
      }
    },
    {
      "displayName": "Workflow Object",
      "name": "workflowObject",
      "type": "json",
      "default": "{ \"name\": \"My workflow\", \"nodes\": [], \"connections\": {}, \"settings\": {} }",
      "description": "A valid JSON object with required fields: 'name', 'nodes', 'connections' and 'settings'. More information can be found in the <a href=\"https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows/post\">documentation</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Workflow",
      "name": "workflowId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Workflow to filter the executions by",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "deactivate"
          ]
        }
      }
    },
    {
      "displayName": "Workflow",
      "name": "workflowId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Workflow to filter the executions by",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Return Only Active Workflows",
          "name": "activeWorkflows",
          "type": "boolean",
          "default": true,
          "routing": {
            "request": {
              "qs": {
                "active": "={{ $value }}"
              }
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "query",
              "property": "tags",
              "value": "={{ $value !== \"\" ? $value : undefined }}"
            }
          },
          "description": "Include only workflows with these tags",
          "hint": "Comma separated list of tags (empty value is ignored)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Workflow",
      "name": "workflowId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Workflow to filter the executions by",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Workflow",
      "name": "workflowId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Workflow to filter the executions by",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Workflow Object",
      "name": "workflowObject",
      "type": "json",
      "default": "",
      "description": "A valid JSON object with required fields: 'name', 'nodes', 'connections' and 'settings'. More information can be found in the <a href=\"https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows~1%7Bid%7D/put\">documentation</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workflow"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    }
  ]

operations:
  [
    {
      "operation": "generate",
      "name": "Generate",
      "description": "Generate a security audit for this n8n instance"
    }
  ]


