# nodes

node_type: nodes-base.keapTrigger
package_name: n8n-nodes-base
display_name: Keap Trigger
description: Starts the workflow when Infusionsoft events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "keapOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Keap Trigger node documentation
  description: Learn how to use the Keap Trigger node in n8n. Follow technical documentation to integrate Keap Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Keap Trigger node

  [Keap](https://keap.com/){:target=_blank .external-link} is an e-mail marketing and sales platform for small businesses, including products to manage and optimize the customer lifecycle, customer relationship management, marketing automation, lead capture, and e-commerce.

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

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

properties_schema:
  [
    {
      "displayName": "Event Name or ID",
      "name": "eventId",
      "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,
      "typeOptions": {
        "loadOptionsMethod": "getEvents"
      }
    },
    {
      "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"
    }
  ]


node_type: nodes-base.kitemaker
package_name: n8n-nodes-base
display_name: Kitemaker
description: Consume the Kitemaker GraphQL API
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "kitemakerApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Kitemaker node documentation
  description: Learn how to use the Kitemaker node in n8n. Follow technical documentation to integrate Kitemaker node into your workflows.
  contentType: [integration, reference]
  ---

  # Kitemaker node

  Use the Kitemaker node to automate work in Kitemaker, and integrate Kitemaker with other applications. n8n has built-in support for a wide range of Kitemaker features, including retrieving data on organizations, spaces and users, as well as creating, getting, and updating work items. 

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

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

  ## Operations

  * Organization
      * Retrieve data on the logged-in user's organization.
  * Space
      * Retrieve data on all the spaces in the logged-in user's organization.
  * User
      * Retrieve data on all the users in the logged-in user's organization.
  * Work Item
      * Create
      * Get
      * Get All
      * Update

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "workItem",
      "options": [
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Space",
          "value": "space"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "Work Item",
          "value": "workItem"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve data on the logged-in user's organization",
          "action": "Get the logged-in user's organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve data on many spaces in the logged-in user's organization",
          "action": "Get many spaces"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "space"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "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": [
            "space"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "space"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve data on many users in the logged-in user's organization",
          "action": "Get many users"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "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": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a work item"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a work item"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many work items"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a work item"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the work item to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Space Name or ID",
      "name": "spaceId",
      "type": "options",
      "default": [],
      "description": "ID of the space to retrieve the work items from. 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": [
            "workItem"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "displayName": "Status Name or ID",
      "name": "statusId",
      "type": "options",
      "default": [],
      "description": "ID of the status to set on the item to create. 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": [
            "workItem"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "spaceId"
        ],
        "loadOptionsMethod": "getStatuses"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the item to create. Markdown supported."
        },
        {
          "displayName": "Effort",
          "name": "effort",
          "type": "options",
          "default": "SMALL",
          "description": "Effort to set for the item to create",
          "options": [
            {
              "name": "Small",
              "value": "SMALL"
            },
            {
              "name": "Medium",
              "value": "MEDIUM"
            },
            {
              "name": "Large",
              "value": "LARGE"
            }
          ]
        },
        {
          "displayName": "Impact",
          "name": "impact",
          "type": "options",
          "default": "SMALL",
          "description": "Impact to set for the item to create",
          "options": [
            {
              "name": "Small",
              "value": "SMALL"
            },
            {
              "name": "Medium",
              "value": "MEDIUM"
            },
            {
              "name": "Large",
              "value": "LARGE"
            }
          ]
        },
        {
          "displayName": "Label Names or IDs",
          "name": "labelIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getLabels"
          },
          "default": [],
          "description": "ID of the label to set on the item to create. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Member Names or IDs",
          "name": "memberIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": [],
          "description": "ID of the user to assign to the item to create. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Work Item ID",
      "name": "workItemId",
      "type": "string",
      "default": "",
      "description": "ID of the work item to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Space Name or ID",
      "name": "spaceId",
      "type": "options",
      "default": [],
      "description": "ID of the space to retrieve the work items from. 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": [
            "workItem"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "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": [
            "workItem"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Work Item ID",
      "name": "workItemId",
      "type": "string",
      "default": "",
      "description": "ID of the work item to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the item to update. Markdown supported."
        },
        {
          "displayName": "Effort",
          "name": "effort",
          "type": "options",
          "default": "SMALL",
          "description": "Effort to set for the item to update",
          "options": [
            {
              "name": "Small",
              "value": "SMALL"
            },
            {
              "name": "Medium",
              "value": "MEDIUM"
            },
            {
              "name": "Large",
              "value": "LARGE"
            }
          ]
        },
        {
          "displayName": "Impact",
          "name": "impact",
          "type": "options",
          "default": "SMALL",
          "description": "Impact to set for the item to update",
          "options": [
            {
              "name": "Small",
              "value": "SMALL"
            },
            {
              "name": "Medium",
              "value": "MEDIUM"
            },
            {
              "name": "Large",
              "value": "LARGE"
            }
          ]
        },
        {
          "displayName": "Status Name or ID",
          "name": "statusId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getStatuses"
          },
          "default": [],
          "description": "ID of the status to set on the item to update. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title to set for the work item to update"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "workItem"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve data on the logged-in user's organization"
    }
  ]


node_type: nodes-base.koBoToolbox
package_name: n8n-nodes-base
display_name: KoBoToolbox
description: Work with KoBoToolbox forms and submissions
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "koBoToolboxApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: KoboToolbox node documentation
  description: Learn how to use the KoboToolbox node in n8n. Follow technical documentation to integrate KoboToolbox node into your workflows.
  contentType: [integration, reference]
  ---

  # KoboToolbox node

  Use the KoboToolbox node to automate work in KoboToolbox, and integrate KoboToolbox with other applications. n8n has built-in support for a wide range of KoboToolbox features, including creating, updating, deleting, and getting files, forms, hooks, and submissions. 

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

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

  ## Operations

  * File
  	* Create
  	* Delete
  	* Get
  	* Get Many
  * Form
      * Get
      * Get Many
  		* Redeploy
  * Hook
      * Get
      * Get Many
      * Logs
      * Retry All
      * Retry One
  * Submission
      * Delete
      * Get
      * Get Many
      * Get Validation Status
      * Update Validation Status

  ## Templates and examples

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

  ## Options

  ### Query Options

  The Query Submission operation supports query options:

  * In the main section of the **Parameters** panel:
      * **Start** controls the index offset to start the query from (to use the API pagination logic).
      * **Limit** sets the maximum number of records to return. Note that the API always has a limit of 30,000 returned records, whatever value you provide.
  * In the **Query Options** section, you can activate the following parameters:
      * **Query** lets you specify filter predicates in MongoDB's JSON query format. For example: `{"status": "success", "_submission_time": {"$lt": "2021-11-01T01:02:03"}}` queries for all submissions with the value `success` for the field `status`, and submitted before November 1st, 2021, 01:02:03.
      * **Fields** lets you specify the list of fields you want to fetch, to make the response lighter.
      * **Sort** lets you provide a list of sorting criteria in MongoDB JSON format. For example, `{"status": 1, "_submission_time": -1}` specifies a sort order by ascending status, and then descending submission time.

  More details about these options can be found in the [Formhub API docs](https://github.com/SEL-Columbia/formhub/wiki/Formhub-Access-Points-(API)#api-parameters)

  ### Submission options

  All operations that return form submission data offer options to tweak the response. These include:

  - Download options lets you download any attachment linked to each particular form submissions, such as pictures and videos. It also lets you select the naming pattern, and the file size to download (if available - typically for images). 
  - Formatting options perform some reformatting as described in [About reformatting](#about-reformatting).

  #### About reformatting

  The default JSON format for KoboToolbox submission data is sometimes hard to deal with, because it's not schema-aware, and all fields are therefore returned as strings.

  This node provides a lightweight opinionated reformatting logic, enabled with the **Reformat?** parameter, available on all operations that return form submissions: the submission query, get, and the attachment download operations.

  When enabled, the reformatting:

  - Reorganizes the JSON into a multi-level hierarchy following the form's groups. By default, question grouping hierarchy is materialized by a `/` character in the field names, for example `Group1/Question1`. With reformatting enabled, n8n reorganizes these into `Group1.Question1`, as nested JSON objects.
  - Renames fields to trim `_` (not supported by many downstream systems).
  - Parses all geospatial fields (Point, Line, and Area question types) into their standard GeoJSON equivalent.
  - Splits all fields matching any of the **Multiselect Mask** wildcard masks into an array. Since the multi-select fields appear as space-separated strings, they can't be guessed algorithmically, so you must provide a field naming mask. Format the masks as a comma-separated list. Lists support the `*` wildcard.
  - Converts all fields matching any of the **Number Mask** wildcard masks into a JSON float.

  Here's a detailed example in JSON:

  ```json
  {
    "_id": 471987,
    "formhub/uuid": "189436bb09a54957bfcc798e338b54d6",
    "start": "2021-12-05T16:13:38.527+02:00",
    "end": "2021-12-05T16:15:33.407+02:00",
    "Field_Details/Field_Name": "Test Fields",
    "Field_Details/Field_Location": "-1.932914 30.078211 1421 165",
    "Field_Details/Field_Shape": "-1.932914 30.078211 1421 165;-1.933011 30.078085 0 0;-1.933257 30.078004 0 0;-1.933338 30.078197 0 0;-1.933107 30.078299 0 0;-1.932914 30.078211 1421 165",
    "Field_Details/Crops_Grown": "maize beans avocado",
    "Field_Details/Field_Size_sqm": "2300",
    "__version__": "veGcULpqP6JNFKRJbbMvMs",
    "meta/instanceID": "uuid:2356cbbe-c1fd-414d-85c8-84f33e92618a",
    "_xform_id_string": "ajXVJpBkTD5tB4Nu9QXpgm",
    "_uuid": "2356cbbe-c1fd-414d-85c8-84f33e92618a",
    "_attachments": [],
    "_status": "submitted_via_web",
    "_geolocation": [
      -1.932914,
      30.078211
    ],
    "_submission_time": "2021-12-05T14:15:44",
    "_tags": [],
    "_notes": [],
    "_validation_status": {},
    "_submitted_by": null
  }
  ```

  With reformatting enabled, and the appropriate masks for multi-select and number formatting (for example, `Crops_*` and `*_sqm` respectively), n8n parses it into:

  ```json
  {
    "id": 471987,
    "formhub": {
      "uuid": "189436bb09a54957bfcc798e338b54d6"
    },
    "start": "2021-12-05T16:13:38.527+02:00",
    "end": "2021-12-05T16:15:33.407+02:00",
    "Field_Details": {
      "Field_Name": "Test Fields",
      "Field_Location": {
        "lat": -1.932914,
        "lon": 30.078211
      },
      "Field_Shape": {
        "type": "polygon",
        "coordinates": [
          {
            "lat": -1.932914,
            "lon": 30.078211
          },
          {
            "lat": -1.933011,
            "lon": 30.078085
          },
          {
            "lat": -1.933257,
            "lon": 30.078004
          },
          {
            "lat": -1.933338,
            "lon": 30.078197
          },
          {
            "lat": -1.933107,
            "lon": 30.078299
          },
          {
            "lat": -1.932914,
            "lon": 30.078211
          }
        ]
      },
      "Crops_Grown": [
        "maize",
        "beans",
        "avocado"
      ],
      "Field_Size_sqm": 2300
    },
    "version": "veGcULpqP6JNFKRJbbMvMs",
    "meta": {
      "instanceID": "uuid:2356cbbe-c1fd-414d-85c8-84f33e92618a"
    },
    "xform_id_string": "ajXVJpBkTD5tB4Nu9QXpgm",
    "uuid": "2356cbbe-c1fd-414d-85c8-84f33e92618a",
    "attachments": [],
    "status": "submitted_via_web",
    "geolocation": {
      "lat": -1.932914,
      "lon": 30.078211
    },
    "submission_time": "2021-12-05T14:15:44",
    "tags": [],
    "notes": [],
    "validation_status": {},
    "submitted_by": null
  }
  ```


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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "submission",
      "options": [
        {
          "name": "File",
          "value": "file"
        },
        {
          "name": "Form",
          "value": "form"
        },
        {
          "name": "Hook",
          "value": "hook"
        },
        {
          "name": "Submission",
          "value": "submission"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a form",
          "action": "Get a form"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many forms",
          "action": "Get many forms"
        },
        {
          "name": "Redeploy",
          "value": "redeploy",
          "description": "Redeploy Current Form Version",
          "action": "Redeploy Current Form Version"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Name or ID",
      "name": "formId",
      "type": "options",
      "default": "",
      "description": "Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). 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": [
            "form"
          ],
          "operation": [
            "get",
            "redeploy"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadForms"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 1000,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "maxValue": 3000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "placeholder": "Add Sort",
          "options": [
            {
              "displayName": "Sort",
              "name": "value",
              "values": [
                {
                  "displayName": "Descending",
                  "name": "descending",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether to sort by descending order"
                },
                {
                  "displayName": "Order By",
                  "name": "ordering",
                  "type": "options",
                  "default": "date_modified",
                  "options": [
                    {
                      "name": "Asset Type",
                      "value": "asset_type"
                    },
                    {
                      "name": "Date Modified",
                      "value": "date_modified"
                    },
                    {
                      "name": "Name",
                      "value": "name"
                    },
                    {
                      "name": "Owner Username",
                      "value": "owner__username"
                    },
                    {
                      "name": "Subscribers Count",
                      "value": "subscribers_count"
                    }
                  ],
                  "description": "Field to order by"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filter",
          "name": "filter",
          "type": "string",
          "default": "asset_type:survey",
          "description": "A text search query based on form data - e.g. \"owner__username:meg AND name__icontains:quixotic\" - see <a href=\"https://github.com/kobotoolbox/kpi#searching\" target=\"_blank\">docs</a> for more details"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a single hook definition",
          "action": "Get a hook"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "List many hooks on a form",
          "action": "Get Many hooks"
        },
        {
          "name": "Logs",
          "value": "getLogs",
          "description": "Get hook logs",
          "action": "Get Logs for a hook"
        },
        {
          "name": "Retry All",
          "value": "retryAll",
          "description": "Retry all failed attempts for a given hook",
          "action": "Retry All hooks"
        },
        {
          "name": "Retry One",
          "value": "retryOne",
          "description": "Retry a specific hook",
          "action": "Retry One hook"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Name or ID",
      "name": "formId",
      "type": "options",
      "default": "",
      "description": "Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). 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": [
            "hook"
          ],
          "operation": [
            "get",
            "retryOne",
            "retryAll",
            "getLogs",
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadForms"
      }
    },
    {
      "displayName": "Hook ID",
      "name": "hookId",
      "type": "string",
      "default": "",
      "description": "Hook ID (starts with h, e.g. hVehywQ2oXPYGHJHKtqth4)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "get",
            "retryOne",
            "retryAll",
            "getLogs"
          ]
        }
      }
    },
    {
      "displayName": "Hook Log ID",
      "name": "logId",
      "type": "string",
      "default": "",
      "description": "Hook log ID (starts with hl, e.g. hlSbGKaUKzTVNoWEVMYbLHe)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "retryOne"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 1000,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "maxValue": 3000
      }
    },
    {
      "displayName": "Log Status",
      "name": "status",
      "type": "options",
      "default": "",
      "description": "Only retrieve logs with a specific status",
      "options": [
        {
          "name": "All",
          "value": ""
        },
        {
          "name": "Failed",
          "value": "0"
        },
        {
          "name": "Pending",
          "value": "1"
        },
        {
          "name": "Success",
          "value": "2"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "getLogs"
          ]
        }
      }
    },
    {
      "displayName": "Start Date",
      "name": "startDate",
      "type": "dateTime",
      "default": "",
      "description": "Minimum date for the hook log to retrieve",
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "getLogs"
          ]
        }
      }
    },
    {
      "displayName": "End Date",
      "name": "endDate",
      "type": "dateTime",
      "default": "",
      "description": "Maximum date for the hook log to retrieve",
      "displayOptions": {
        "show": {
          "resource": [
            "hook"
          ],
          "operation": [
            "getLogs"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a single submission",
          "action": "Delete a submission"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a single submission",
          "action": "Get a submission"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many submissions",
          "action": "Get many submissions"
        },
        {
          "name": "Get Validation Status",
          "value": "getValidation",
          "description": "Get the validation status for the submission",
          "action": "Get the validation status for a submission"
        },
        {
          "name": "Update Validation Status",
          "value": "setValidation",
          "description": "Set the validation status of the submission",
          "action": "Update the validation status for a submission"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Name or ID",
      "name": "formId",
      "type": "options",
      "default": "",
      "description": "Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). 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": [
            "submission"
          ],
          "operation": [
            "get",
            "delete",
            "getValidation",
            "setValidation",
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadForms"
      }
    },
    {
      "displayName": "Submission ID",
      "name": "submissionId",
      "type": "string",
      "default": "",
      "description": "Submission ID (number, e.g. 245128)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "get",
            "delete",
            "getValidation",
            "setValidation"
          ]
        }
      }
    },
    {
      "displayName": "Validation Status",
      "name": "validationStatus",
      "type": "options",
      "default": "",
      "description": "Desired Validation Status",
      "options": [
        {
          "name": "Approved",
          "value": "validation_status_approved"
        },
        {
          "name": "Not Approved",
          "value": "validation_status_not_approved"
        },
        {
          "name": "On Hold",
          "value": "validation_status_on_hold"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "setValidation"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "maxValue": 3000
      }
    },
    {
      "displayName": "Filter",
      "name": "filterType",
      "type": "options",
      "default": "none",
      "options": [
        {
          "name": "None",
          "value": "none"
        },
        {
          "name": "JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "See <a href=\"https://github.com/SEL-Columbia/formhub/wiki/Formhub-Access-Points-(API)#api-parameters\" target=\"_blank\">Formhub API docs</a> to creating filters, using the MongoDB JSON format - e.g. {\"_submission_time\":{\"$lt\":\"2021-10-01T01:02:03\"}}",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Filters (JSON)",
      "name": "filterJson",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Download Attachments",
          "name": "download",
          "type": "boolean",
          "default": false,
          "description": "Whether to download submitted attachments"
        },
        {
          "displayName": "Attachments Naming Scheme",
          "name": "binaryNamingScheme",
          "type": "options",
          "default": "sequence",
          "displayOptions": {
            "show": {
              "download": [
                true
              ]
            }
          },
          "options": [
            {
              "name": "Sequence (e.g. attachment_N)",
              "value": "sequence"
            },
            {
              "name": "Use Original Form Question ID",
              "value": "question"
            }
          ]
        },
        {
          "displayName": "Attachments Prefix",
          "name": "dataPropertyAttachmentsPrefixName",
          "type": "string",
          "displayOptions": {
            "show": {
              "download": [
                true
              ],
              "binaryNamingScheme": [
                "sequence"
              ]
            }
          },
          "default": "attachment_",
          "description": "Prefix for name of the binary property to which to write the attachments. An index starting with 0 will be added. So if name is \"attachment_\" the first attachment is saved to \"attachment_0\""
        },
        {
          "displayName": "Fields to Retrieve",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to retrieve (e.g. _submission_time,_submitted_by). If left blank, all fields are retrieved."
        },
        {
          "displayName": "File Size",
          "name": "version",
          "type": "options",
          "displayOptions": {
            "show": {
              "download": [
                true
              ]
            }
          },
          "default": "download_url",
          "description": "Attachment size to retrieve, if multiple versions are available",
          "options": [
            {
              "name": "Original",
              "value": "download_url"
            },
            {
              "name": "Small",
              "value": "download_small_url"
            },
            {
              "name": "Medium",
              "value": "download_medium_url"
            },
            {
              "name": "Large",
              "value": "download_large_url"
            }
          ]
        },
        {
          "displayName": "Multiselect Mask",
          "name": "selectMask",
          "type": "string",
          "default": "select_*",
          "description": "Comma-separated list of wildcard-style selectors for fields that should be treated as multiselect fields, i.e. parsed as arrays."
        },
        {
          "displayName": "Number Mask",
          "name": "numberMask",
          "type": "string",
          "default": "n_*, f_*",
          "description": "Comma-separated list of wildcard-style selectors for fields that should be treated as numbers"
        },
        {
          "displayName": "Reformat",
          "name": "reformat",
          "type": "boolean",
          "default": false,
          "description": "Whether to apply some reformatting to the submission data, such as parsing GeoJSON coordinates"
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "json",
          "default": "",
          "description": "Sort predicates, in MongoDB JSON format (e.g. {\"_submission_time\":1})"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "submission"
          ],
          "operation": [
            "get",
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a file",
          "action": "Create a file"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete file",
          "action": "Delete a file"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a file content",
          "action": "Get a file content"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many files",
          "action": "Get many files"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Name or ID",
      "name": "formId",
      "type": "options",
      "default": "",
      "description": "Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). 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": [
            "file"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadForms"
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "Uid of the file (should start with \"af\" e.g. \"afQoJxA4kmKEXVpkH6SYbhb\"",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete",
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property to write the file into",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Download File Content",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the file content into a binary property",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "File Upload Mode",
      "name": "fileMode",
      "type": "options",
      "default": "binary",
      "options": [
        {
          "name": "Binary File",
          "value": "binary"
        },
        {
          "name": "URL",
          "value": "url"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property containing the file to upload. Supported types: image, audio, video, csv, xml, zip.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "create"
          ],
          "fileMode": [
            "binary"
          ]
        }
      }
    },
    {
      "displayName": "File URL",
      "name": "fileUrl",
      "type": "string",
      "default": "",
      "description": "HTTP(s) link to the file to upload",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "create"
          ],
          "fileMode": [
            "url"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a form"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many forms"
    },
    {
      "operation": "redeploy",
      "name": "Redeploy",
      "description": "Redeploy Current Form Version"
    }
  ]


node_type: nodes-base.koBoToolboxTrigger
package_name: n8n-nodes-base
display_name: KoBoToolbox Trigger
description: Process KoBoToolbox submissions
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "koBoToolboxApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: KoboToolbox Trigger node documentation
  description: Learn how to use the KoboToolbox Trigger node in n8n. Follow technical documentation to integrate KoboToolbox Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # KoboToolbox Trigger node

  [KoboToolbox](https://www.kobotoolbox.org/){:target=_blank .external-link} is a field survey and data collection tool to design interactive forms to be completed offline from mobile devices. It's available both as a free cloud solution or as a self-hosted version.

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

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

  This node starts a workflow upon new submissions of a specified form. The trigger node handles the creation/deletion of the hook, so you don't need to do any setup in KoboToolbox.

  It works the same way as the Get Submission operation in the [KoboToolbox](/integrations/builtin/app-nodes/n8n-nodes-base.kobotoolbox.md) node, including supporting the same reformatting options.

properties_schema:
  [
    {
      "displayName": "Form Name or ID",
      "name": "formId",
      "type": "options",
      "default": "",
      "description": "Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "loadForms"
      }
    },
    {
      "displayName": "Trigger On",
      "name": "triggerOn",
      "type": "options",
      "default": "formSubmission",
      "options": [
        {
          "name": "On Form Submission",
          "value": "formSubmission"
        }
      ],
      "required": true
    },
    {
      "displayName": "Options",
      "name": "formatOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Download Attachments",
          "name": "download",
          "type": "boolean",
          "default": false,
          "description": "Whether to download submitted attachments"
        },
        {
          "displayName": "Attachments Naming Scheme",
          "name": "binaryNamingScheme",
          "type": "options",
          "default": "sequence",
          "displayOptions": {
            "show": {
              "download": [
                true
              ]
            }
          },
          "options": [
            {
              "name": "Sequence (e.g. attachment_N)",
              "value": "sequence"
            },
            {
              "name": "Use Original Form Question ID",
              "value": "question"
            }
          ]
        },
        {
          "displayName": "Attachments Prefix",
          "name": "dataPropertyAttachmentsPrefixName",
          "type": "string",
          "displayOptions": {
            "show": {
              "download": [
                true
              ],
              "binaryNamingScheme": [
                "sequence"
              ]
            }
          },
          "default": "attachment_",
          "description": "Prefix for name of the binary property to which to write the attachments. An index starting with 0 will be added. So if name is \"attachment_\" the first attachment is saved to \"attachment_0\""
        },
        {
          "displayName": "File Size",
          "name": "version",
          "type": "options",
          "displayOptions": {
            "show": {
              "download": [
                true
              ]
            }
          },
          "default": "download_url",
          "description": "Attachment size to retrieve, if multiple versions are available",
          "options": [
            {
              "name": "Original",
              "value": "download_url"
            },
            {
              "name": "Small",
              "value": "download_small_url"
            },
            {
              "name": "Medium",
              "value": "download_medium_url"
            },
            {
              "name": "Large",
              "value": "download_large_url"
            }
          ]
        },
        {
          "displayName": "Multiselect Mask",
          "name": "selectMask",
          "type": "string",
          "default": "select_*",
          "description": "Comma-separated list of wildcard-style selectors for fields that should be treated as multiselect fields, i.e. parsed as arrays."
        },
        {
          "displayName": "Number Mask",
          "name": "numberMask",
          "type": "string",
          "default": "n_*, f_*",
          "description": "Comma-separated list of wildcard-style selectors for fields that should be treated as numbers"
        },
        {
          "displayName": "Reformat",
          "name": "reformat",
          "type": "boolean",
          "default": false,
          "description": "Whether to apply some reformatting to the submission data, such as parsing GeoJSON coordinates"
        }
      ]
    }
  ]


node_type: nodes-base.ldap
package_name: n8n-nodes-base
display_name: Ldap
description: Interact with LDAP servers
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "ldap",
  "required": true,
  "testedBy": "ldapConnectionTest"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: LDAP
  description: Documentation for the LDAP node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  ---

  # LDAP

  This node allows you to interact with your LDAP servers to create, find, and update objects.

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

  ## Operations

  * [**Compare**](#compare) an attribute
  * [**Create**](#create) a new entry
  * [**Delete**](#delete) an entry
  * [**Rename**](#rename) the DN of an existing entry
  * [**Search**](#search) LDAP
  * [**Update**](#update) attributes

  Refer to the sections below for details on configuring the node for each operation.

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

  ## Compare

  Configure this operation using these parameters:

  * **Credential to connect with**: Select or create an [LDAP credential](/integrations/builtin/credentials/ldap.md) to connect with.
  * **DN**: Enter the Distinguished Name (DN) of the entry to compare.
  * **Attribute ID**: Enter the ID of the attribute to compare.
  * **Value**: Enter the value to compare.

  ## Create

  Configure this operation using these parameters:

  * **Credential to connect with**: Select or create an [LDAP credential](/integrations/builtin/credentials/ldap.md) to connect with.
  * **DN**: Enter the Distinguished Name (DN) of the entry to create.
  * **Attributes**: Add the **Attribute ID**/**Value** pairs you'd like to create.

  ## Delete

  Configure this operation using these parameters:

  * **Credential to connect with**: Select or create an [LDAP credential](/integrations/builtin/credentials/ldap.md) to connect with.
  * **DN**: Enter the Distinguished Name (DN) of the entry to be deleted.

  ## Rename

  Configure this operation using these parameters:

  * **Credential to connect with**: Select or create an [LDAP credential](/integrations/builtin/credentials/ldap.md) to connect with.
  * **DN**: Enter the current Distinguished Name (DN) of the entry to rename.
  * **New DN**: Enter the new Distinguished Name (DN) for the entry in this field.

  ## Search

  Configure this operation using these parameters:

  * **Credential to connect with**: Select or create an [LDAP credential](/integrations/builtin/credentials/ldap.md) to connect with.
  * **Base DN**: Enter the Distinguished Name (DN) of the subtree to search in.
  * **Search For**: Select the directory object class to search for.
  * **Attribute**: Select the attribute to search for.
  * **Search Text**: Enter the text to search for. Use `*` for a wildcard.
  * **Return All**: When turned on, the node will return all results. When turned off, the node will return results up to the set **Limit**.
  * **Limit**: Only available when you turn off **Return All**. Enter the maximum number of results to return.

  ### Search options

  You can also configure this operation using these options:

  * **Attribute Names or IDs**: Enter a comma-separated list of attributes to return. Choose from the list or specify IDs using an expression.
  * **Page Size**: Enter the maximum number of results to request at one time. Set to 0 to disable paging.
  * **Scopes**: The set of entries at or below the **Base DN** to search for potential matches. Select from:
      * **Base Tree**: Often referred to as subordinateSubtree or just "subordinates," selecting this option will search the subordinates of the **Base DN** entry but not the **Base DN** entry itself.
      * **Single Level**: Often referred to as "one," selecting this option will search only the immediate children of the **Base DN** entry.
      * **Whole Subtree**: Often referred to as "sub," selecting this option will search the **Base DN** entry and all its subordinates to any depth.

  Refer to [The LDAP Search Operation](https://ldap.com/the-ldap-search-operation/){:target="_blank" .external-link} for more information on search scopes.

  ## Update

  Configure this operation using these parameters:

  * **Credential to connect with**: Select or create an [LDAP credential](/integrations/builtin/credentials/ldap.md) to connect with.
  * **DN**: Enter the Distinguished Name (DN) of the entry to update.
  * ***Update Attributes**: Select whether to **Add** new, **Remove** existing, or **Replace** existing attribute.
  * Then enter the **Attribute ID**/**Value** pair you'd like to update.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "search",
      "options": [
        {
          "name": "Compare",
          "value": "compare",
          "description": "Compare an attribute",
          "action": "Compare an attribute"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new entry",
          "action": "Create a new entry"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an entry",
          "action": "Delete an entry"
        },
        {
          "name": "Rename",
          "value": "rename",
          "description": "Rename the DN of an existing entry",
          "action": "Rename the DN of an existing entry"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search LDAP",
          "action": "Search LDAP"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update attributes",
          "action": "Update attributes"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Debug",
      "name": "nodeDebug",
      "type": "boolean",
      "default": false,
      "noDataExpression": true
    },
    {
      "displayName": "DN",
      "name": "dn",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the entry to compare",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "compare"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": false
      }
    },
    {
      "displayName": "DN",
      "name": "dn",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the entry to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": false
      }
    },
    {
      "displayName": "DN",
      "name": "dn",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the entry to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": false
      }
    },
    {
      "displayName": "DN",
      "name": "dn",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the entry to rename",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "rename"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": false
      }
    },
    {
      "displayName": "DN",
      "name": "dn",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the entry to modify",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "modify"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": false
      }
    },
    {
      "displayName": "DN",
      "name": "dn",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the entry to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": false
      }
    },
    {
      "displayName": "Attribute ID",
      "name": "id",
      "type": "options",
      "default": [],
      "description": "The ID of the attribute to compare",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "compare"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAttributesForDn"
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The value to compare",
      "displayOptions": {
        "show": {
          "operation": [
            "compare"
          ]
        }
      }
    },
    {
      "displayName": "New DN",
      "name": "targetDn",
      "type": "string",
      "default": "",
      "description": "The new distinguished name for the entry",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "rename"
          ]
        }
      }
    },
    {
      "displayName": "Attributes",
      "name": "attributes",
      "type": "fixedCollection",
      "default": {},
      "description": "Attributes to add to the entry",
      "options": [
        {
          "name": "attribute",
          "displayName": "Attribute",
          "values": [
            {
              "displayName": "Attribute ID",
              "name": "id",
              "type": "string",
              "default": "",
              "description": "The ID of the attribute to add",
              "required": true
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute to set"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Update Attributes",
      "name": "attributes",
      "type": "fixedCollection",
      "default": {},
      "description": "Update entry attributes",
      "options": [
        {
          "name": "add",
          "displayName": "Add",
          "values": [
            {
              "displayName": "Attribute ID",
              "name": "id",
              "type": "string",
              "default": "",
              "description": "The ID of the attribute to add",
              "required": true
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute to set"
            }
          ]
        },
        {
          "name": "replace",
          "displayName": "Replace",
          "values": [
            {
              "displayName": "Attribute ID",
              "name": "id",
              "type": "string",
              "default": "",
              "description": "The ID of the attribute to replace",
              "required": true
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute to replace"
            }
          ]
        },
        {
          "name": "delete",
          "displayName": "Remove",
          "values": [
            {
              "displayName": "Attribute ID",
              "name": "id",
              "type": "string",
              "default": "",
              "description": "The ID of the attribute to remove",
              "required": true
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute to remove"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Base DN",
      "name": "baseDN",
      "type": "string",
      "default": "",
      "description": "The distinguished name of the subtree to search in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Search For",
      "name": "searchFor",
      "type": "options",
      "default": [],
      "description": "Directory object class to search for",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getObjectClasses"
      }
    },
    {
      "displayName": "Custom Filter",
      "name": "customFilter",
      "type": "string",
      "default": "(objectclass=*)",
      "description": "Custom LDAP filter. Escape these chars * ( ) \\ with a backslash \"\\\".",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "searchFor": [
            "custom"
          ]
        }
      }
    },
    {
      "displayName": "Attribute",
      "name": "attribute",
      "type": "options",
      "default": [],
      "description": "Attribute to search for",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        },
        "hide": {
          "searchFor": [
            "custom"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAttributes"
      }
    },
    {
      "displayName": "Search Text",
      "name": "searchText",
      "type": "string",
      "default": "",
      "description": "Text to search for, Use * for a wildcard",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        },
        "hide": {
          "searchFor": [
            "custom"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attribute Names or IDs",
          "name": "attributes",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getAttributes"
          },
          "default": [],
          "description": "Comma-separated list of attributes to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Page Size",
          "name": "pageSize",
          "type": "number",
          "default": 1000,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Maximum number of results to request at one time. Set to 0 to disable paging."
        },
        {
          "displayName": "Scope",
          "name": "scope",
          "default": "sub",
          "description": "The set of entries at or below the BaseDN that may be considered potential matches",
          "type": "options",
          "options": [
            {
              "name": "Base Object",
              "value": "base"
            },
            {
              "name": "Single Level",
              "value": "one"
            },
            {
              "name": "Whole Subtree",
              "value": "sub"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "compare",
      "name": "Compare",
      "description": "Compare an attribute"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new entry"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an entry"
    },
    {
      "operation": "rename",
      "name": "Rename",
      "description": "Rename the DN of an existing entry"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search LDAP"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update attributes"
    }
  ]


node_type: nodes-base.lemlist
package_name: n8n-nodes-base
display_name: Lemlist
description: Consume the Lemlist API
category: transform
development_style: programmatic
version: 2
operations:
  [
  {
  "operation": "getAll",
  "name": "Get Many"
  }
  ]

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

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Lemlist node documentation
  description: Learn how to use the Lemlist node in n8n. Follow technical documentation to integrate Lemlist node into your workflows.
  contentType: [integration, reference]
  ---

  # Lemlist node

  Use the Lemlist node to automate work in Lemlist, and integrate Lemlist with other applications. n8n has built-in support for a wide range of Lemlist features, including getting activities, teams and campaigns, as well as creating, updating, and deleting leads. 

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

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

  ## Operations

  <!-- vale from-write-good.Weasel = NO -->
  <!-- vale from-write-good.TooWordy = NO -->
  * Activity
      * Get Many: Get many activities
  * Campaign
      * Get Many: Get many campaigns
      * Get Stats: Get campaign stats
  * Enrichment
  	* Get: Fetches a previously completed enrichment
  	* Enrich Lead: Enrich a lead using an email or LinkedIn URL
  	* Enrich Person: Enrich a person using an email or LinkedIn URL
  * Lead
      * Create: Create a new lead
      * Delete: Delete an existing lead
      * Get: Get an existing lead
      * Unsubscribe: Unsubscribe an existing lead
  * Team
      * Get: Get an existing team
  	* Get Credits: Get an existing team's credits
  * Unsubscribe
      * Add: Add an email to an unsubscribe list
      * Delete: Delete an email from an unsubscribe list
      * Get Many: Get many unsubscribed emails
  <!-- vale from-write-good.TooWordy = YES -->
  <!-- vale from-write-good.Weasel = YES -->

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "activity",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Campaign",
          "value": "campaign"
        },
        {
          "name": "Enrichment",
          "value": "enrich"
        },
        {
          "name": "Lead",
          "value": "lead"
        },
        {
          "name": "Team",
          "value": "team"
        },
        {
          "name": "Unsubscribe",
          "value": "unsubscribe"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many activities"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "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": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Campaign Name or ID",
          "name": "campaignId",
          "type": "options",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getCampaigns"
          },
          "description": "ID of the campaign to retrieve activity for. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Is First",
          "name": "isFirst",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Lead ID",
          "name": "leadId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "default": "emailsOpened",
          "description": "Type of activity to retrieve",
          "options": [
            {
              "name": "Aircall Created",
              "value": "aircallCreated"
            },
            {
              "name": "Aircall Done",
              "value": "aircallDone"
            },
            {
              "name": "Aircall Ended",
              "value": "aircallEnded"
            },
            {
              "name": "Aircall Interested",
              "value": "aircallInterested"
            },
            {
              "name": "Aircall Not Interested",
              "value": "aircallNotInterested"
            },
            {
              "name": "Api Done",
              "value": "apiDone"
            },
            {
              "name": "Api Failed",
              "value": "apiFailed"
            },
            {
              "name": "Api Interested",
              "value": "apiInterested"
            },
            {
              "name": "Api Not Interested",
              "value": "apiNotInterested"
            },
            {
              "name": "Attracted",
              "value": "attracted"
            },
            {
              "name": "Connection Issue",
              "value": "connectionIssue"
            },
            {
              "name": "Contacted",
              "value": "contacted"
            },
            {
              "name": "Custom Domain Errors",
              "value": "customDomainErrors"
            },
            {
              "name": "Emails Bounced",
              "value": "emailsBounced"
            },
            {
              "name": "Emails Clicked",
              "value": "emailsClicked"
            },
            {
              "name": "Emails Failed",
              "value": "emailsFailed"
            },
            {
              "name": "Emails Interested",
              "value": "emailsInterested"
            },
            {
              "name": "Emails Not Interested",
              "value": "emailsNotInterested"
            },
            {
              "name": "Emails Opened",
              "value": "emailsOpened"
            },
            {
              "name": "Emails Replied",
              "value": "emailsReplied"
            },
            {
              "name": "Emails Send Failed",
              "value": "emailsSendFailed"
            },
            {
              "name": "Emails Sent",
              "value": "emailsSent"
            },
            {
              "name": "Emails Unsubscribed",
              "value": "emailsUnsubscribed"
            },
            {
              "name": "Hooked",
              "value": "hooked"
            },
            {
              "name": "Interested",
              "value": "interested"
            },
            {
              "name": "Lemwarm Paused",
              "value": "lemwarmPaused"
            },
            {
              "name": "LinkedIn Interested",
              "value": "linkedinInterested"
            },
            {
              "name": "LinkedIn Invite Accepted",
              "value": "linkedinInviteAccepted"
            },
            {
              "name": "LinkedIn Invite Done",
              "value": "linkedinInviteDone"
            },
            {
              "name": "LinkedIn Invite Failed",
              "value": "linkedinInviteFailed"
            },
            {
              "name": "LinkedIn Not Interested",
              "value": "linkedinNotInterested"
            },
            {
              "name": "LinkedIn Replied",
              "value": "linkedinReplied"
            },
            {
              "name": "LinkedIn Send Failed",
              "value": "linkedinSendFailed"
            },
            {
              "name": "LinkedIn Sent",
              "value": "linkedinSent"
            },
            {
              "name": "LinkedIn Visit Done",
              "value": "linkedinVisitDone"
            },
            {
              "name": "LinkedIn Visit Failed",
              "value": "linkedinVisitFailed"
            },
            {
              "name": "LinkedIn Voice Note Done",
              "value": "linkedinVoiceNoteDone"
            },
            {
              "name": "LinkedIn Voice Note Failed",
              "value": "linkedinVoiceNoteFailed"
            },
            {
              "name": "Manual Interested",
              "value": "manualInterested"
            },
            {
              "name": "Manual Not Interested",
              "value": "manualNotInterested"
            },
            {
              "name": "Not Interested",
              "value": "notInterested"
            },
            {
              "name": "Opportunities Done",
              "value": "opportunitiesDone"
            },
            {
              "name": "Paused",
              "value": "paused"
            },
            {
              "name": "Resumed",
              "value": "resumed"
            },
            {
              "name": "Send Limit Reached",
              "value": "sendLimitReached"
            },
            {
              "name": "Skipped",
              "value": "skipped"
            },
            {
              "name": "Warmed",
              "value": "warmed"
            }
          ]
        },
        {
          "displayName": "Version",
          "name": "version",
          "type": "string",
          "default": "v2"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many campaigns"
        },
        {
          "name": "Get Stats",
          "value": "getStats",
          "action": "Get campaign stats"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "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": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Version",
          "name": "version",
          "type": "string",
          "default": "v2"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "type": "options",
      "default": [],
      "description": "ID of the campaign to get stats for. 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": [
            "campaign"
          ],
          "operation": [
            "getStats"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Start Date",
      "name": "startDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getStats"
          ]
        }
      }
    },
    {
      "displayName": "End Date",
      "name": "endDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getStats"
          ]
        }
      }
    },
    {
      "displayName": "Timezone",
      "name": "timezone",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getStats"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Fetches a previously completed enrichment"
        },
        {
          "name": "Enrich Lead",
          "value": "enrichLead",
          "action": "Enrich a lead using an email or LinkedIn URL"
        },
        {
          "name": "Enrich Person",
          "value": "enrichPerson",
          "action": "Enrich a person using an email or LinkedIn URL"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Enrichment ID",
      "name": "enrichId",
      "type": "string",
      "default": "",
      "description": "ID of the enrichment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Lead ID",
      "name": "leadId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "enrichLead"
          ]
        }
      }
    },
    {
      "displayName": "Find Email",
      "name": "findEmail",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "enrichLead",
            "enrichPerson"
          ]
        }
      }
    },
    {
      "displayName": "Verify Email",
      "name": "verifyEmail",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "enrichLead",
            "enrichPerson"
          ]
        }
      }
    },
    {
      "displayName": "LinkedIn Enrichment",
      "name": "linkedinEnrichment",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "enrichLead",
            "enrichPerson"
          ]
        }
      }
    },
    {
      "displayName": "Find Phone",
      "name": "findPhone",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "enrichLead",
            "enrichPerson"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Url",
          "name": "linkedinUrl",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Name",
          "name": "companyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Domain",
          "name": "companyDomain",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "enrich"
          ],
          "operation": [
            "enrichPerson"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a lead"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a lead"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a lead"
        },
        {
          "name": "Unsubscribe",
          "value": "unsubscribe",
          "action": "Unsubscribe a lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "type": "options",
      "default": [],
      "description": "ID of the campaign to create the lead under. 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": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the lead to create",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company Name",
          "name": "companyName",
          "type": "string",
          "default": "",
          "description": "Company name of the lead to create"
        },
        {
          "displayName": "Company Domain",
          "name": "companyDomain",
          "type": "string",
          "default": "",
          "description": "Company domain of the lead to create"
        },
        {
          "displayName": "Deduplicate",
          "name": "deduplicate",
          "type": "boolean",
          "default": false,
          "description": "Whether to do not insert if this email is already present in another campaign"
        },
        {
          "displayName": "Find Email",
          "name": "findEmail",
          "type": "boolean",
          "default": false,
          "description": "Whether to find verified email"
        },
        {
          "displayName": "Find Phone",
          "name": "findPhone",
          "type": "boolean",
          "default": false,
          "description": "Whether to find phone number"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the lead to create"
        },
        {
          "displayName": "Icebreaker",
          "name": "icebreaker",
          "type": "string",
          "default": "",
          "description": "Icebreaker of the lead to create"
        },
        {
          "displayName": "Job Title",
          "name": "jobTitle",
          "type": "string",
          "default": "",
          "description": "Job title of the lead to create"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the lead to create"
        },
        {
          "displayName": "LinkedIn Enrichment",
          "name": "linkedinEnrichment",
          "type": "boolean",
          "default": false,
          "description": "Whether to run the LinkedIn enrichment"
        },
        {
          "displayName": "LinkedIn URL",
          "name": "linkedinUrl",
          "type": "string",
          "default": "",
          "description": "LinkedIn URL of the lead to create"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "Phone number of the lead to create"
        },
        {
          "displayName": "Picture URL",
          "name": "picture",
          "type": "string",
          "default": "",
          "description": "Picture URL of the lead to create"
        },
        {
          "displayName": "Verify Email",
          "name": "verifyEmail",
          "type": "boolean",
          "default": false,
          "description": "Whether to verify existing email (debounce)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "type": "options",
      "default": [],
      "description": "ID of the campaign to remove the lead from. 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": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the lead to delete",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the lead to retrieve",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "type": "options",
      "default": [],
      "description": "ID of the campaign to unsubscribe the lead from. 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": [
            "lead"
          ],
          "operation": [
            "unsubscribe"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the lead to unsubscribe",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "unsubscribe"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a team"
        },
        {
          "name": "Get Credits",
          "value": "getCredits",
          "action": "Get team credits"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add an email to an unsubscribe list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an email from an unsubscribe list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many unsubscribed emails"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "unsubscribe"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email to add to the unsubscribes",
      "displayOptions": {
        "show": {
          "resource": [
            "unsubscribe"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email to delete from the unsubscribes",
      "displayOptions": {
        "show": {
          "resource": [
            "unsubscribe"
          ],
          "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": [
            "unsubscribe"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "unsubscribe"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    }
  ]


node_type: nodes-base.lemlistTrigger
package_name: n8n-nodes-base
display_name: Lemlist Trigger
description: Handle Lemlist events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "lemlistApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Lemlist Trigger node documentation
  description: Learn how to use the Lemlist Trigger node in n8n. Follow technical documentation to integrate Lemlist Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Lemlist Trigger node

  [Lemlist](https://Lemlist.com){:target=_blank .external-link} is an email outreach platform that allows you to automatically generate personalized images and videos and send personalized cold emails.

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

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

  ## Events

  <!-- vale Vale.Spelling = NO -->
  - *
  - Aircall Created
  - Aircall Done
  - Aircall Ended
  - Aircall Interested
  - Aircall Not Interested
  - Api Done
  - Api Failed
  - Api Interested
  - Api Not Interested
  - Attracted
  - Connection Issue
  - Contacted
  - Custom Domain Errors
  - Emails Bounced
  - Emails Clicked
  - Emails Failed
  - Emails Interested
  - Emails Not Interested
  - Emails Opened
  - Emails Replied
  - Emails Send Failed
  - Emails Sent
  - Emails Unsubscribed
  - Hooked
  - Interested
  - Lemwarm Paused
  - LinkedIn Interested
  - LinkedIn Invite Accepted
  - LinkedIn Invite Done
  - LinkedIn Invite Failed
  - LinkedIn Not Interested
  - LinkedIn Replied
  - LinkedIn Send Failed
  - LinkedIn Sent
  - LinkedIn Visit Done
  - LinkedIn Visit Failed
  - LinkedIn Voice Note Done
  - LinkedIn Voice Note Failed
  - Manual Interested
  - Manual Not Interested
  - Not Interested
  - Opportunities Done
  - Paused
  - Resumed
  - Send Limit Reached
  - Skipped
  - Warmed
  <!-- vale Vale.Spelling = YES -->

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "*",
          "value": "*"
        },
        {
          "name": "Contacted",
          "value": "contacted"
        },
        {
          "name": "Hooked",
          "value": "hooked"
        },
        {
          "name": "Attracted",
          "value": "attracted"
        },
        {
          "name": "Warmed",
          "value": "warmed"
        },
        {
          "name": "Interested",
          "value": "interested"
        },
        {
          "name": "Skipped",
          "value": "skipped"
        },
        {
          "name": "Not Interested",
          "value": "notInterested"
        },
        {
          "name": "Emails Sent",
          "value": "emailsSent"
        },
        {
          "name": "Emails Opened",
          "value": "emailsOpened"
        },
        {
          "name": "Emails Clicked",
          "value": "emailsClicked"
        },
        {
          "name": "Emails Replied",
          "value": "emailsReplied"
        },
        {
          "name": "Emails Bounced",
          "value": "emailsBounced"
        },
        {
          "name": "Emails Send Failed",
          "value": "emailsSendFailed"
        },
        {
          "name": "Emails Failed",
          "value": "emailsFailed"
        },
        {
          "name": "Emails Unsubscribed",
          "value": "emailsUnsubscribed"
        },
        {
          "name": "Emails Interested",
          "value": "emailsInterested"
        },
        {
          "name": "Emails Not Interested",
          "value": "emailsNotInterested"
        },
        {
          "name": "Opportunities Done",
          "value": "opportunitiesDone"
        },
        {
          "name": "Aircall Created",
          "value": "aircallCreated"
        },
        {
          "name": "Aircall Ended",
          "value": "aircallEnded"
        },
        {
          "name": "Aircall Done",
          "value": "aircallDone"
        },
        {
          "name": "Aircall Interested",
          "value": "aircallInterested"
        },
        {
          "name": "Aircall Not Interested",
          "value": "aircallNotInterested"
        },
        {
          "name": "Api Done",
          "value": "apiDone"
        },
        {
          "name": "Api Interested",
          "value": "apiInterested"
        },
        {
          "name": "Api Not Interested",
          "value": "apiNotInterested"
        },
        {
          "name": "Api Failed",
          "value": "apiFailed"
        },
        {
          "name": "LinkedIn Visit Done",
          "value": "linkedinVisitDone"
        },
        {
          "name": "LinkedIn Visit Failed",
          "value": "linkedinVisitFailed"
        },
        {
          "name": "LinkedIn Invite Done",
          "value": "linkedinInviteDone"
        },
        {
          "name": "LinkedIn Invite Failed",
          "value": "linkedinInviteFailed"
        },
        {
          "name": "LinkedIn Invite Accepted",
          "value": "linkedinInviteAccepted"
        },
        {
          "name": "LinkedIn Replied",
          "value": "linkedinReplied"
        },
        {
          "name": "LinkedIn Sent",
          "value": "linkedinSent"
        },
        {
          "name": "LinkedIn Voice Note Done",
          "value": "linkedinVoiceNoteDone"
        },
        {
          "name": "LinkedIn Voice Note Failed",
          "value": "linkedinVoiceNoteFailed"
        },
        {
          "name": "LinkedIn Interested",
          "value": "linkedinInterested"
        },
        {
          "name": "LinkedIn Not Interested",
          "value": "linkedinNotInterested"
        },
        {
          "name": "LinkedIn Send Failed",
          "value": "linkedinSendFailed"
        },
        {
          "name": "Manual Interested",
          "value": "manualInterested"
        },
        {
          "name": "Manual Not Interested",
          "value": "manualNotInterested"
        },
        {
          "name": "Paused",
          "value": "paused"
        },
        {
          "name": "Resumed",
          "value": "resumed"
        },
        {
          "name": "Custom Domain Errors",
          "value": "customDomainErrors"
        },
        {
          "name": "Connection Issue",
          "value": "connectionIssue"
        },
        {
          "name": "Send Limit Reached",
          "value": "sendLimitReached"
        },
        {
          "name": "Lemwarm Paused",
          "value": "lemwarmPaused"
        }
      ],
      "required": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Campaign Name or ID",
          "name": "campaignId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCampaigns"
          },
          "default": "",
          "description": "We'll call this hook only for this campaignId. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Is First",
          "name": "isFirst",
          "type": "boolean",
          "default": false,
          "description": "Whether to call this hook only the first time this activity happened"
        }
      ]
    }
  ]


node_type: nodes-base.line
package_name: n8n-nodes-base
display_name: Line
description: Consume Line API
category: input
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Line node documentation
  description: Learn how to use the Line node in n8n. Follow technical documentation to integrate Line node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Line node

  <!-- vale off -->
  /// warning | Deprecated: End of service
  LINE Notify is discontinuing service as of April 1st 2025 and this node will no longer work after that date. View LINE Notify's [end of service announement](https://notify-bot.line.me/closing-announce){:target=_blank .external-link} for more information.
  ///
  <!-- vale on -->

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

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

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

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

  ## Operations

  * Notification
      * Sends notifications to users or groups

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "End of service: LINE Notify will be discontinued from April 1st 2025, You can find more information <a href=\"https://notify-bot.line.me/closing-announce\" target=\"_blank\">here</a>",
      "name": "notice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "notification",
      "options": [
        {
          "name": "Notification",
          "value": "notification"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Sends notifications to users or groups",
          "action": "Send a notification"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "notification"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "notification"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Image",
          "name": "imageUi",
          "placeholder": "Add Image",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "imageValue",
              "displayName": "Image",
              "values": [
                {
                  "displayName": "Binary File",
                  "name": "binaryData",
                  "type": "boolean",
                  "default": false
                },
                {
                  "displayName": "Image Full Size",
                  "name": "imageFullsize",
                  "type": "string",
                  "default": "",
                  "displayOptions": {
                    "show": {
                      "binaryData": [
                        false
                      ]
                    }
                  },
                  "description": "HTTP/HTTPS URL. Maximum size of 2048×2048px JPEG."
                },
                {
                  "displayName": "Image Thumbnail",
                  "name": "imageThumbnail",
                  "type": "string",
                  "displayOptions": {
                    "show": {
                      "binaryData": [
                        false
                      ]
                    }
                  },
                  "default": "",
                  "description": "HTTP/HTTPS URL. Maximum size of 240×240px JPEG."
                },
                {
                  "displayName": "Input Binary Field",
                  "name": "binaryProperty",
                  "type": "string",
                  "displayOptions": {
                    "show": {
                      "binaryData": [
                        true
                      ]
                    }
                  },
                  "default": "data",
                  "hint": "The name of the input binary field containing the file to be written"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Notification Disabled",
          "name": "notificationDisabled",
          "type": "boolean",
          "default": false,
          "description": "<p>true: The user doesn't receive a push notification when the message is sent.</p><p>false: The user receives a push notification when the message is sent</p>"
        },
        {
          "displayName": "Sticker",
          "name": "stickerUi",
          "placeholder": "Add Sticker",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "stickerValue",
              "displayName": "Sticker",
              "values": [
                {
                  "displayName": "Sticker ID",
                  "name": "stickerId",
                  "type": "number",
                  "default": ""
                },
                {
                  "displayName": "Sticker Package ID",
                  "name": "stickerPackageId",
                  "type": "number",
                  "default": "",
                  "description": "Package ID"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "notification"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send",
      "description": "Sends notifications to users or groups"
    }
  ]

credentials_required:
  [
    {
      "name": "lineNotifyOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "notification"
          ]
        }
      }
    }
  ]


node_type: nodes-base.linear
package_name: n8n-nodes-base
display_name: Linear
description: Consume Linear API
category: output
development_style: programmatic
version: 1.1
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Linear node documentation
  description: Learn how to use the Linear node in n8n. Follow technical documentation to integrate Linear node into your workflows.
  contentType: [integration, reference]
  ---

  # Linear node

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

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

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

  ## Operations

  * Issue
      * 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, 'linear') ]]

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "issue",
      "options": [
        {
          "name": "Comment",
          "value": "comment"
        },
        {
          "name": "Issue",
          "value": "issue"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "addComment",
      "options": [
        {
          "name": "Add Comment",
          "value": "addComment",
          "description": "Add a comment to an issue",
          "action": "Add a comment to an issue"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "comment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "comment"
          ],
          "operation": [
            "addComment"
          ]
        }
      }
    },
    {
      "displayName": "Comment",
      "name": "comment",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "comment"
          ],
          "operation": [
            "addComment"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Parent Comment ID",
          "name": "parentId",
          "type": "string",
          "description": "ID of the parent comment if this is a reply",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "comment"
          ],
          "operation": [
            "addComment"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add Link",
          "value": "addLink",
          "description": "Add a link to an issue",
          "action": "Add a link to an issue"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create an issue",
          "action": "Create an issue"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an issue",
          "action": "Delete an issue"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an issue",
          "action": "Get an issue"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many issues",
          "action": "Get many issues"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an issue",
          "action": "Update an issue"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "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": [
            "issue"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigneeId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priorityId",
          "type": "options",
          "options": [
            {
              "name": "Urgent",
              "value": 1
            },
            {
              "name": "High",
              "value": 2
            },
            {
              "name": "Normal",
              "value": 3
            },
            {
              "name": "Low",
              "value": 4
            },
            {
              "name": "No Priority",
              "value": 0
            }
          ],
          "default": 0
        },
        {
          "displayName": "State Name or ID",
          "name": "stateId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStates"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "addLink",
            "get",
            "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": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigneeId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority Name/ID",
          "name": "priorityId",
          "type": "options",
          "options": [
            {
              "name": "Urgent",
              "value": 1
            },
            {
              "name": "High",
              "value": 2
            },
            {
              "name": "Medium",
              "value": 3
            },
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "No Priority",
              "value": 0
            }
          ],
          "default": 0
        },
        {
          "displayName": "State Name or ID",
          "name": "stateId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStates"
          },
          "default": ""
        },
        {
          "displayName": "Team Name or ID",
          "name": "teamId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getTeams"
          },
          "default": ""
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ],
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigneeId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority Name/ID",
          "name": "priorityId",
          "type": "options",
          "options": [
            {
              "name": "Urgent",
              "value": 1
            },
            {
              "name": "High",
              "value": 2
            },
            {
              "name": "Medium",
              "value": 3
            },
            {
              "name": "Low",
              "value": 4
            },
            {
              "name": "No Priority",
              "value": 0
            }
          ],
          "default": 0
        },
        {
          "displayName": "State Name or ID",
          "name": "stateId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStates"
          },
          "default": ""
        },
        {
          "displayName": "Team Name or ID",
          "name": "teamId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getTeams"
          },
          "default": ""
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Link",
      "name": "link",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "addLink"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "addComment",
      "name": "Add Comment",
      "description": "Add a comment to an issue"
    }
  ]

credentials_required:
  [
    {
      "name": "linearApi",
      "required": true,
      "testedBy": "linearApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "apiToken"
          ]
        }
      }
    },
    {
      "name": "linearOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.linearTrigger
package_name: n8n-nodes-base
display_name: Linear Trigger
description: Starts the workflow when Linear events occur
category: trigger
development_style: programmatic
version: 1
operations: []
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Linear Trigger node documentation
  description: Learn how to use the Linear Trigger node in n8n. Follow technical documentation to integrate Linear Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Linear Trigger node

  [Linear](https://linear.app/){:target=_blank .external-link} is a SaaS issue tracking tool.

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

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

  ## Events

  - Comment Reaction
  - Cycle
  - Issue
  - Issue Comment
  - Issue Label
  - Project

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Make sure your credential has the \"Admin\" scope to create webhooks.",
      "name": "notice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "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": "getTeams"
      }
    },
    {
      "displayName": "Listen to Resources",
      "name": "resources",
      "type": "multiOptions",
      "default": [],
      "options": [
        {
          "name": "Comment Reaction",
          "value": "reaction"
        },
        {
          "name": "Cycle",
          "value": "cycle"
        },
        {
          "name": "Issue",
          "value": "issue"
        },
        {
          "name": "Issue Comment",
          "value": "comment"
        },
        {
          "name": "Issue Label",
          "value": "issueLabel"
        },
        {
          "name": "Project",
          "value": "project"
        }
      ],
      "required": true
    }
  ]

credentials_required:
  [
    {
      "name": "linearApi",
      "required": true,
      "testedBy": "linearApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "apiToken"
          ]
        }
      }
    },
    {
      "name": "linearOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.lingvaNex
package_name: n8n-nodes-base
display_name: LingvaNex
description: Consume LingvaNex API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "lingvaNexApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: LingvaNex node documentation
  description: Learn how to use the LingvaNex node in n8n. Follow technical documentation to integrate LingvaNex node into your workflows.
  contentType: [integration, reference]
  ---

  # LingvaNex node

  Use the LingvaNex node to automate work in LingvaNex, and integrate LingvaNex with other applications. n8n has built-in support for translating data with LingvaNex.

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

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

  ## Operations

  - Translate data

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "translate",
      "options": [
        {
          "name": "Translate",
          "value": "translate",
          "description": "Translate data",
          "action": "Translate data"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The input text to translate",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "translate"
          ]
        }
      }
    },
    {
      "displayName": "Translate To",
      "name": "translateTo",
      "type": "options",
      "default": "",
      "description": "The language to use for translation of the input text, set to one of the language codes listed in <a href=\"https://cloud.google.com/translate/docs/languages\">Language Support</a>. 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": [
            "translate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLanguages"
      }
    },
    {
      "displayName": "Additional Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "From",
          "name": "from",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getLanguages"
          },
          "default": "",
          "description": "The language code in the format “language code_code of the country”. If this parameter is not present, the auto-detect language mode is enabled. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Platform",
          "name": "platform",
          "type": "string",
          "default": "api"
        },
        {
          "displayName": "Translate Mode",
          "name": "translateMode",
          "type": "string",
          "default": "",
          "description": "Describe the input text format. Possible value is \"html\" for translating and preserving html structure. If value is not specified or is other than \"html\" than plain text is translating."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "translate"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "translate",
      "name": "Translate",
      "description": "Translate data"
    }
  ]


node_type: nodes-base.linkedIn
package_name: n8n-nodes-base
display_name: LinkedIn
description: Consume LinkedIn API
category: input
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "create",
  "name": "Create",
  "description": "Create a new post"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: LinkedIn node documentation
  description: Learn how to use the LinkedIn node in n8n. Follow technical documentation to integrate LinkedIn node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # LinkedIn node

  Use the LinkedIn node to automate work in LinkedIn, and integrate LinkedIn with other applications. n8n supports creating posts.

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

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

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

  ## Operations

  * Post
      * Create

  ## Parameters

  * **Post As**: choose whether to post as a **Person** or **Organization**.
  * **Person Name or ID** and **Organization URN**: enter an identifier for the person or organization.

  	/// note | Posting as organization
  	If posting as an Organization enter the organization number in the URN field. For example, `03262013` not `urn:li:company:03262013`.
  	///
  	
  * **Text**: the post contents.
  * **Media Category**: use this when including images or article URLs in your post.

  ## Templates and examples

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

  ## Related resources

  Refer to [LinkedIn's API documentation](https://learn.microsoft.com/en-us/linkedin/){:target=_blank .external-link} for more information about the service.

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "standard",
      "options": [
        {
          "name": "Standard",
          "value": "standard"
        },
        {
          "name": "Community Management",
          "value": "communityManagement"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Post",
          "value": "post"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new post",
          "action": "Create a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Post As",
      "name": "postAs",
      "type": "options",
      "default": "person",
      "description": "If to post on behalf of a user or an organization",
      "options": [
        {
          "name": "Person",
          "value": "person"
        },
        {
          "name": "Organization",
          "value": "organization"
        }
      ]
    },
    {
      "displayName": "Person Name or ID",
      "name": "person",
      "type": "options",
      "default": "",
      "description": "Person as which the post should be posted as. 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"
          ],
          "postAs": [
            "person"
          ],
          "resource": [
            "post"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPersonUrn"
      }
    },
    {
      "displayName": "Organization URN",
      "name": "organization",
      "type": "string",
      "default": "",
      "description": "URN of Organization as which the post should be posted as",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "postAs": [
            "organization"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The primary content of the post",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Media Category",
      "name": "shareMediaCategory",
      "type": "options",
      "default": "NONE",
      "options": [
        {
          "name": "None",
          "value": "NONE",
          "description": "The post does not contain any media, and will only consist of text"
        },
        {
          "name": "Article",
          "value": "ARTICLE",
          "description": "The post contains an article URL"
        },
        {
          "name": "Image",
          "value": "IMAGE",
          "description": "The post contains an image"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ],
          "shareMediaCategory": [
            "IMAGE"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Provide a short description for your image or article",
          "displayOptions": {
            "show": {
              "/shareMediaCategory": [
                "ARTICLE"
              ]
            }
          }
        },
        {
          "displayName": "Original URL",
          "name": "originalUrl",
          "type": "string",
          "default": "",
          "description": "Provide the URL of the article you would like to share here",
          "displayOptions": {
            "show": {
              "/shareMediaCategory": [
                "ARTICLE"
              ]
            }
          }
        },
        {
          "displayName": "Input Binary Field",
          "name": "thumbnailBinaryPropertyName",
          "type": "string",
          "default": "data",
          "hint": "The name of the input binary field containing the file for the article thumbnail",
          "displayOptions": {
            "show": {
              "/shareMediaCategory": [
                "ARTICLE"
              ]
            }
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Customize the title of your image or article",
          "displayOptions": {
            "show": {
              "/shareMediaCategory": [
                "ARTICLE",
                "IMAGE"
              ]
            }
          }
        },
        {
          "displayName": "Visibility",
          "name": "visibility",
          "type": "options",
          "default": "PUBLIC",
          "description": "Dictate if post will be seen by the public or only connections",
          "displayOptions": {
            "show": {
              "/postAs": [
                "person"
              ]
            }
          },
          "options": [
            {
              "name": "Connections",
              "value": "CONNECTIONS"
            },
            {
              "name": "Public",
              "value": "PUBLIC"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    }
  ]

credentials_required:
  [
    {
      "name": "linkedInOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "standard"
          ]
        }
      }
    },
    {
      "name": "linkedInCommunityManagementOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "communityManagement"
          ]
        }
      }
    }
  ]


node_type: nodes-base.localFileTrigger
package_name: n8n-nodes-base
display_name: Local File Trigger
description: Triggers a workflow on file system changes
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Local File Trigger node documentation
  description: Learn how to use the Local File Trigger node in n8n. Follow technical documentation to integrate Local File Trigger node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Local File Trigger node

  The Local File Trigger node starts a workflow when it detects changes on the file system. These changes involve a file or folder getting added, changed, or deleted.

  /// note | Self-hosted n8n only
  This node isn't available on n8n Cloud.
  ///

  ## Node parameters

  You can choose what event to watch for using the **Trigger On** parameter.

  ## Changes to a Specific File

  The node triggers when the specified file changes.

  Enter the path for the file to watch in **File to Watch**.

  ## Changes Involving a Specific Folder

  The node triggers when a change occurs in the selected folder.

  Configure these parameters:

  - **Folder to Watch**: Enter the path of the folder to watch.
  - **Watch for**: Select the type of change to watch for.


  ## Node options

  Use the node **Options** to include or exclude files and folders.

  - **Include Linked Files/Folders**: also watch for changes to linked files or folders.
  - **Ignore**: files or paths to ignore. n8n tests the whole path, not just the filename. Supports the [Anymatch](https://github.com/micromatch/anymatch){:target=_blank .external-link} syntax.
  - **Max Folder Depth**: how deep into the folder structure to watch for changes.

  ### Examples for Ignore

  Ignore a single file:

  ```sh
  **/<fileName>.<suffix>
  # For example, **/myfile.txt
  ```

  Ignore a sub-directory of a directory you're watching:

  ```sh
  **/<directoryName>/**
  # For example, **/myDirectory/**
  ```

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Trigger On",
      "name": "triggerOn",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Changes to a Specific File",
          "value": "file"
        },
        {
          "name": "Changes Involving a Specific Folder",
          "value": "folder"
        }
      ],
      "required": true
    },
    {
      "displayName": "File to Watch",
      "name": "path",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "triggerOn": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Folder to Watch",
      "name": "path",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "triggerOn": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Watch for",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events to listen to",
      "options": [
        {
          "name": "File Added",
          "value": "add",
          "description": "Triggers whenever a new file was added"
        },
        {
          "name": "File Changed",
          "value": "change",
          "description": "Triggers whenever a file was changed"
        },
        {
          "name": "File Deleted",
          "value": "unlink",
          "description": "Triggers whenever a file was deleted"
        },
        {
          "name": "Folder Added",
          "value": "addDir",
          "description": "Triggers whenever a new folder was added"
        },
        {
          "name": "Folder Deleted",
          "value": "unlinkDir",
          "description": "Triggers whenever a folder was deleted"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "triggerOn": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Await Write Finish",
          "name": "awaitWriteFinish",
          "type": "boolean",
          "default": false,
          "description": "Whether to wait until files finished writing to avoid partially read"
        },
        {
          "displayName": "Include Linked Files/Folders",
          "name": "followSymlinks",
          "type": "boolean",
          "default": true,
          "description": "Whether linked files/folders will also be watched (this includes symlinks, aliases on MacOS and shortcuts on Windows). Otherwise only the links themselves will be monitored)."
        },
        {
          "displayName": "Ignore",
          "name": "ignored",
          "type": "string",
          "default": "",
          "placeholder": "**/*.txt or ignore-me/subfolder",
          "description": "Files or paths to ignore. The whole path is tested, not just the filename. Supports <a href=\"https://github.com/micromatch/anymatch\">Anymatch</a>- syntax. Regex patterns may not work on macOS. To ignore files based on substring matching, use the 'Ignore Mode' option with 'Contain'."
        },
        {
          "displayName": "Ignore Existing Files/Folders",
          "name": "ignoreInitial",
          "type": "boolean",
          "default": true,
          "description": "Whether to ignore existing files/folders to not trigger an event"
        },
        {
          "displayName": "Max Folder Depth",
          "name": "depth",
          "type": "options",
          "options": [
            {
              "name": "1 Levels Down",
              "value": 1
            },
            {
              "name": "2 Levels Down",
              "value": 2
            },
            {
              "name": "3 Levels Down",
              "value": 3
            },
            {
              "name": "4 Levels Down",
              "value": 4
            },
            {
              "name": "5 Levels Down",
              "value": 5
            },
            {
              "name": "Top Folder Only",
              "value": 0
            },
            {
              "name": "Unlimited",
              "value": -1
            }
          ],
          "default": -1,
          "description": "How deep into the folder structure to watch for changes"
        },
        {
          "displayName": "Use Polling",
          "name": "usePolling",
          "type": "boolean",
          "default": false,
          "description": "Whether to use polling for watching. Typically necessary to successfully watch files over a network."
        },
        {
          "displayName": "Ignore Mode",
          "name": "ignoreMode",
          "type": "options",
          "options": [
            {
              "name": "Match",
              "value": "match",
              "description": "Ignore files using regex patterns (e.g., **/*.txt), Not supported on macOS"
            },
            {
              "name": "Contain",
              "value": "contain",
              "description": "Ignore files if their path contains the specified value"
            }
          ],
          "default": "match",
          "description": "Whether to ignore files using regex matching (Anymatch patterns) or by checking if the path contains a specified value"
        }
      ]
    }
  ]


node_type: nodes-base.loneScaleTrigger
package_name: n8n-nodes-base
display_name: LoneScale Trigger
description: Trigger LoneScale Workflow
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "loneScaleApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: LoneScale Trigger node documentation
  description: Learn how to use the LoneScale Trigger node in n8n. Follow technical documentation to integrate LoneScale Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # LoneScale Trigger node

  Use the LoneScale Trigger node to respond to workflow events in [LoneScale](https://www.lonescale.com/){:target=_blank .external-link} and integrate LoneScale with other applications.

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

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

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

  ## Events

  - On new LoneScale event

  ## Related resources

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

  View [example workflows and related content](https://n8n.io/integrations/lonescale-trigger/){:target=_blank .external-link} on n8n's website.

properties_schema:
  [
    {
      "displayName": "Workflow Name",
      "name": "workflow",
      "type": "options",
      "default": "",
      "description": "Select one workflow. Choose from the list",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getWorkflows"
      },
      "noDataExpression": true
    }
  ]


node_type: nodes-base.loneScale
package_name: n8n-nodes-base
display_name: LoneScale
description: Create List, add / delete items
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "create",
  "name": "Create",
  "description": "Create a list"
  }
  ]

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

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: LoneScale node documentation
  description: Learn how to use the LoneScale node in n8n. Follow technical documentation to integrate LoneScale node into your workflows.
  contentType: [integration, reference]
  ---

  # LoneScale node

  Use the LoneScale node to automate work in LoneScale and integrate LoneScale with other applications. n8n has built-in support for managing Lists and Items in LoneScale. 

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

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

  ## Operations

  * List
  	* Create
  * Item
  	* Create

  ## Templates and examples

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

  ## Related resources

  Refer to [LoneScales documentation](https://help-center.lonescale.com/en/articles/6454360-lonescale-public-api){:target=_blank .external-link} for more information about the service.

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "list",
      "description": "Create a new list",
      "options": [
        {
          "name": "List",
          "value": "list",
          "description": "Manipulate list"
        },
        {
          "name": "Item",
          "value": "item",
          "description": "Manipulate item"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Create",
          "value": "add",
          "description": "Create an item",
          "action": "Create a item"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "PEOPLE",
      "description": "Type of your list",
      "options": [
        {
          "name": "Company",
          "value": "COMPANY",
          "description": "List of company"
        },
        {
          "name": "Contact",
          "value": "PEOPLE",
          "description": "List of contact"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "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": [
            "item"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists",
        "loadOptionsDependsOn": [
          "type"
        ]
      }
    },
    {
      "displayName": "First Name",
      "name": "first_name",
      "type": "string",
      "default": "",
      "description": "Contact first name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "item"
          ],
          "type": [
            "PEOPLE"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "last_name",
      "type": "string",
      "default": "",
      "description": "Contact last name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "item"
          ],
          "type": [
            "PEOPLE"
          ]
        }
      }
    },
    {
      "displayName": "Company Name",
      "name": "company_name",
      "type": "string",
      "default": "",
      "description": "Contact company name",
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "item"
          ],
          "type": [
            "COMPANY"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "peopleAdditionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Full Name",
          "name": "full_name",
          "type": "string",
          "default": "",
          "description": "Contact full name"
        },
        {
          "displayName": "Contact Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Company Name",
          "name": "company_name",
          "type": "string",
          "default": "",
          "description": "Contact company name"
        },
        {
          "displayName": "Current Position",
          "name": "current_position",
          "type": "string",
          "default": "",
          "description": "Contact current position"
        },
        {
          "displayName": "Company Domain",
          "name": "domain",
          "type": "string",
          "default": "",
          "description": "Contact company domain"
        },
        {
          "displayName": "Linkedin Url",
          "name": "linkedin_url",
          "type": "string",
          "default": "",
          "description": "Contact Linkedin URL"
        },
        {
          "displayName": "Contact Location",
          "name": "location",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Contact ID",
          "name": "contact_id",
          "type": "string",
          "default": "",
          "description": "Contact ID from your source"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "item"
          ],
          "type": [
            "PEOPLE"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "companyAdditionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Linkedin Url",
          "name": "linkedin_url",
          "type": "string",
          "default": "",
          "description": "Company Linkedin URL"
        },
        {
          "displayName": "Company Domain",
          "name": "domain",
          "type": "string",
          "default": "",
          "description": "Company company domain"
        },
        {
          "displayName": "Contact Location",
          "name": "location",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Contact ID",
          "name": "contact_id",
          "type": "string",
          "default": "",
          "description": "Contact ID from your source"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "item"
          ],
          "type": [
            "COMPANY"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of your list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "COMPANY",
      "description": "Type of your list",
      "options": [
        {
          "name": "Company",
          "value": "COMPANY",
          "description": "Create a list of companies",
          "action": "Create a list of companies"
        },
        {
          "name": "Contact",
          "value": "PEOPLE",
          "description": "Create a list of contacts",
          "action": "Create a list of contacts"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    }
  ]


node_type: nodes-base.magento2
package_name: n8n-nodes-base
display_name: Magento 2
description: Consume Magento API
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "magento2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Magento 2 node documentation
  description: Learn how to use the Magento 2 node in n8n. Follow technical documentation to integrate Magento 2 node into your workflows.
  contentType: [integration, reference]
  ---

  # Magento 2 node

  Use the Magento 2 node to automate work in Magento 2, and integrate Magento 2 with other applications. n8n has built-in support for a wide range of Magento 2 features, including creating, updating, deleting, and getting customers, invoices, orders, and projects. 

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

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

  ## Operations

  * Customer
      * Create a new customer
      * Delete a customer
      * Get a customer
      * Get all customers
      * Update a customer
  * Invoice
      * Create an invoice
  * Order
      * Cancel an order
      * Get an order
      * Get all orders
      * Ship an order
  * Product
      * Create a product
      * Delete a product
      * Get a product
      * Get all products
      * Update a product

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "customer",
      "options": [
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Order",
          "value": "order"
        },
        {
          "name": "Product",
          "value": "product"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new customer",
          "action": "Create a customer"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a customer",
          "action": "Delete a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a customer",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many customers",
          "action": "Get many customers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a customer",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the user to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstname",
      "type": "string",
      "default": "",
      "description": "First name of the user to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastname",
      "type": "string",
      "default": "",
      "description": "Last name of the user to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Addresses",
          "name": "addresses",
          "placeholder": "Add Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Address",
              "name": "address",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Region",
                  "name": "region",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postcode",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Country Name or ID",
                  "name": "country_id",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "typeOptions": {
                    "loadOptionsMethod": "getCountries"
                  },
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Company",
                  "name": "company",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Fax",
                  "name": "fax",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "First Name",
                  "name": "firstname",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Last Name",
                  "name": "lastname",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Middle Name",
                  "name": "middlename",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Prefix",
                  "name": "prefix",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Suffix",
                  "name": "suffix",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Telephone",
                  "name": "telephone",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Default Billing",
                  "name": "default_billing",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether this address is default billing address"
                },
                {
                  "displayName": "Default Shipping",
                  "name": "default_shipping",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether this address is default shipping address"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Amazon ID",
          "name": "amazon_id",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Confirmation",
          "name": "confirmation",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Attributes",
          "name": "customAttributes",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Custom Attribute",
          "options": [
            {
              "displayName": "Custom Attribute",
              "name": "customAttribute",
              "values": [
                {
                  "displayName": "Attribute Code Name or ID",
                  "name": "attribute_code",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomAttributes"
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date of Birth",
          "name": "dob",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Default Billing Address ID",
          "name": "default_billing",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Default Shipping Address ID",
          "name": "default_shipping",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Male",
              "value": 1
            },
            {
              "name": "Female",
              "value": 2
            },
            {
              "name": "Not Specified",
              "value": 3
            }
          ],
          "default": ""
        },
        {
          "displayName": "Group Name or ID",
          "name": "group_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          },
          "default": ""
        },
        {
          "displayName": "Is Subscribed",
          "name": "is_subscribed",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Middle Name",
          "name": "middlename",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": ""
        },
        {
          "displayName": "Prefix",
          "name": "prefix",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Store Name or ID",
          "name": "store_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStores"
          },
          "default": ""
        },
        {
          "displayName": "Suffix",
          "name": "suffix",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vertex Customer Code",
          "name": "vertex_customer_code",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vertex Customer Country",
          "name": "vertex_customer_country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website Name or ID",
          "name": "website_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/operation": [
                "create"
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getWebsites"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to update",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Website Name or ID",
      "name": "website_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>",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWebsites"
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Addresses",
          "name": "addresses",
          "placeholder": "Add Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Address",
              "name": "address",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Region",
                  "name": "region",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postcode",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Country Name or ID",
                  "name": "country_id",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "typeOptions": {
                    "loadOptionsMethod": "getCountries"
                  },
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Company",
                  "name": "company",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Fax",
                  "name": "fax",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "First Name",
                  "name": "firstname",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Last Name",
                  "name": "lastname",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Middle Name",
                  "name": "middlename",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Prefix",
                  "name": "prefix",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Suffix",
                  "name": "suffix",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Telephone",
                  "name": "telephone",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Default Billing",
                  "name": "default_billing",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether this address is default billing address"
                },
                {
                  "displayName": "Default Shipping",
                  "name": "default_shipping",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether this address is default shipping address"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Amazon ID",
          "name": "amazon_id",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Confirmation",
          "name": "confirmation",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Attributes",
          "name": "customAttributes",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Custom Attribute",
          "options": [
            {
              "displayName": "Custom Attribute",
              "name": "customAttribute",
              "values": [
                {
                  "displayName": "Attribute Code Name or ID",
                  "name": "attribute_code",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomAttributes"
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date of Birth",
          "name": "dob",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Default Billing Address ID",
          "name": "default_billing",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Default Shipping Address ID",
          "name": "default_shipping",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Male",
              "value": 1
            },
            {
              "name": "Female",
              "value": 2
            },
            {
              "name": "Not Specified",
              "value": 3
            }
          ],
          "default": ""
        },
        {
          "displayName": "Group Name or ID",
          "name": "group_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          },
          "default": ""
        },
        {
          "displayName": "Is Subscribed",
          "name": "is_subscribed",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Middle Name",
          "name": "middlename",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": ""
        },
        {
          "displayName": "Prefix",
          "name": "prefix",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Store Name or ID",
          "name": "store_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStores"
          },
          "default": ""
        },
        {
          "displayName": "Suffix",
          "name": "suffix",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vertex Customer Code",
          "name": "vertex_customer_code",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vertex Customer Country",
          "name": "vertex_customer_country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website Name or ID",
          "name": "website_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/operation": [
                "create"
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getWebsites"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "delete",
            "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": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Filter",
      "name": "filterType",
      "type": "options",
      "default": "none",
      "options": [
        {
          "name": "None",
          "value": "none"
        },
        {
          "name": "Build Manually",
          "value": "manual"
        },
        {
          "name": "JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Must Match",
      "name": "matchType",
      "type": "options",
      "default": "anyFilter",
      "options": [
        {
          "name": "Any filter",
          "value": "anyFilter"
        },
        {
          "name": "All Filters",
          "value": "allFilters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Field",
              "name": "field",
              "type": "options",
              "typeOptions": {
                "loadOptionsMethod": "getSystemAttributes"
              },
              "default": ""
            },
            {
              "displayName": "Condition Type",
              "name": "condition_type",
              "type": "options",
              "options": [
                {
                  "name": "Equals",
                  "value": "eq"
                },
                {
                  "name": "Greater than",
                  "value": "gt"
                },
                {
                  "name": "Greater than or equal",
                  "value": "gteq"
                },
                {
                  "name": "In",
                  "value": "in",
                  "description": "The value can contain a comma-separated list of values"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                },
                {
                  "name": "Less Than or Equal",
                  "value": "lte"
                },
                {
                  "name": "Like",
                  "value": "like",
                  "description": "The value can contain the SQL wildcard characters when like is specified"
                },
                {
                  "name": "More or Equal",
                  "value": "moreq"
                },
                {
                  "name": "Not Equal",
                  "value": "neq"
                },
                {
                  "name": "Not In",
                  "value": "nin",
                  "description": "The value can contain a comma-separated list of values"
                },
                {
                  "name": "Not Null",
                  "value": "notnull"
                },
                {
                  "name": "Null",
                  "value": "null"
                }
              ],
              "default": "eq"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "displayOptions": {
                "hide": {
                  "condition_type": [
                    "null",
                    "notnull"
                  ]
                }
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "See <a href=\"https://devdocs.magento.com/guides/v2.4/rest/performing-searches.html\" target=\"_blank\">Magento guide</a> to creating filters",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Filters (JSON)",
      "name": "filterJson",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "fixedCollection",
          "placeholder": "Add Sort",
          "typeOptions": {
            "multipleValues": true
          },
          "default": [],
          "options": [
            {
              "displayName": "Sort",
              "name": "sort",
              "values": [
                {
                  "displayName": "Direction",
                  "name": "direction",
                  "type": "options",
                  "options": [
                    {
                      "name": "Ascending",
                      "value": "ASC"
                    },
                    {
                      "name": "Descending",
                      "value": "DESC"
                    }
                  ],
                  "default": "ASC",
                  "description": "The sorting direction"
                },
                {
                  "displayName": "Field",
                  "name": "field",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getSystemAttributes"
                  },
                  "default": "",
                  "description": "The sorting field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an invoice",
          "action": "Create an invoice"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Order ID",
      "name": "orderId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "cancel",
      "options": [
        {
          "name": "Cancel",
          "value": "cancel",
          "description": "Cancel an order",
          "action": "Cancel an order"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an order",
          "action": "Get an order"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many orders",
          "action": "Get many orders"
        },
        {
          "name": "Ship",
          "value": "ship",
          "description": "Ship an order",
          "action": "Ship an order"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Order ID",
      "name": "orderId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "cancel",
            "get",
            "ship"
          ]
        }
      }
    },
    {
      "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": [
            "order"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Filter",
      "name": "filterType",
      "type": "options",
      "default": "none",
      "options": [
        {
          "name": "None",
          "value": "none"
        },
        {
          "name": "Build Manually",
          "value": "manual"
        },
        {
          "name": "JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Must Match",
      "name": "matchType",
      "type": "options",
      "default": "anyFilter",
      "options": [
        {
          "name": "Any filter",
          "value": "anyFilter"
        },
        {
          "name": "All Filters",
          "value": "allFilters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Field",
              "name": "field",
              "type": "options",
              "typeOptions": {
                "loadOptionsMethod": "getOrderAttributes"
              },
              "default": ""
            },
            {
              "displayName": "Condition Type",
              "name": "condition_type",
              "type": "options",
              "options": [
                {
                  "name": "Equals",
                  "value": "eq"
                },
                {
                  "name": "Greater than",
                  "value": "gt"
                },
                {
                  "name": "Greater than or equal",
                  "value": "gteq"
                },
                {
                  "name": "In",
                  "value": "in",
                  "description": "The value can contain a comma-separated list of values"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                },
                {
                  "name": "Less Than or Equal",
                  "value": "lte"
                },
                {
                  "name": "Like",
                  "value": "like",
                  "description": "The value can contain the SQL wildcard characters when like is specified"
                },
                {
                  "name": "More or Equal",
                  "value": "moreq"
                },
                {
                  "name": "Not Equal",
                  "value": "neq"
                },
                {
                  "name": "Not In",
                  "value": "nin",
                  "description": "The value can contain a comma-separated list of values"
                },
                {
                  "name": "Not Null",
                  "value": "notnull"
                },
                {
                  "name": "Null",
                  "value": "null"
                }
              ],
              "default": "eq"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "displayOptions": {
                "hide": {
                  "condition_type": [
                    "null",
                    "notnull"
                  ]
                }
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "See <a href=\"https://devdocs.magento.com/guides/v2.4/rest/performing-searches.html\" target=\"_blank\">Magento guide</a> to creating filters",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Filters (JSON)",
      "name": "filterJson",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "fixedCollection",
          "placeholder": "Add Sort",
          "typeOptions": {
            "multipleValues": true
          },
          "default": [],
          "options": [
            {
              "displayName": "Sort",
              "name": "sort",
              "values": [
                {
                  "displayName": "Direction",
                  "name": "direction",
                  "type": "options",
                  "options": [
                    {
                      "name": "Ascending",
                      "value": "ASC"
                    },
                    {
                      "name": "Descending",
                      "value": "DESC"
                    }
                  ],
                  "default": "ASC",
                  "description": "The sorting direction"
                },
                {
                  "displayName": "Field",
                  "name": "field",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getOrderAttributes"
                  },
                  "default": "",
                  "description": "The sorting field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a product",
          "action": "Create a product"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a product",
          "action": "Delete a product"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a product",
          "action": "Get a product"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many products",
          "action": "Get many products"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a product",
          "action": "Update a product"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "SKU",
      "name": "sku",
      "type": "string",
      "default": "",
      "description": "Stock-keeping unit of the product",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Attribute Set Name or ID",
      "name": "attributeSetId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAttributeSets"
      }
    },
    {
      "displayName": "Price",
      "name": "price",
      "type": "number",
      "default": 0,
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attribute Set Name or ID",
          "name": "attribute_set_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getAttributeSets"
          },
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Price",
          "name": "price",
          "type": "number",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "default": 0
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Enabled",
              "value": 1
            },
            {
              "name": "Disabled",
              "value": 2
            }
          ],
          "default": 1
        },
        {
          "displayName": "Type Name or ID",
          "name": "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>",
          "typeOptions": {
            "loadOptionsMethod": "getProductTypes"
          },
          "default": ""
        },
        {
          "displayName": "Visibility",
          "name": "visibility",
          "type": "options",
          "options": [
            {
              "name": "Not Visible",
              "value": 1
            },
            {
              "name": "Catalog",
              "value": 2
            },
            {
              "name": "Search",
              "value": 3
            },
            {
              "name": "Catalog & Search",
              "value": 4
            }
          ],
          "default": 4
        },
        {
          "displayName": "Weight (LBS)",
          "name": "weight",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attribute Set Name or ID",
          "name": "attribute_set_id",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getAttributeSets"
          },
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Price",
          "name": "price",
          "type": "number",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "default": 0
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Enabled",
              "value": 1
            },
            {
              "name": "Disabled",
              "value": 2
            }
          ],
          "default": 1
        },
        {
          "displayName": "Type Name or ID",
          "name": "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>",
          "typeOptions": {
            "loadOptionsMethod": "getProductTypes"
          },
          "default": ""
        },
        {
          "displayName": "Visibility",
          "name": "visibility",
          "type": "options",
          "options": [
            {
              "name": "Not Visible",
              "value": 1
            },
            {
              "name": "Catalog",
              "value": 2
            },
            {
              "name": "Search",
              "value": 3
            },
            {
              "name": "Catalog & Search",
              "value": 4
            }
          ],
          "default": 4
        },
        {
          "displayName": "Weight (LBS)",
          "name": "weight",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "SKU",
      "name": "sku",
      "type": "string",
      "default": "",
      "description": "Stock-keeping unit of the product",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "delete",
            "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": [
            "product"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Filter",
      "name": "filterType",
      "type": "options",
      "default": "none",
      "options": [
        {
          "name": "None",
          "value": "none"
        },
        {
          "name": "Build Manually",
          "value": "manual"
        },
        {
          "name": "JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Must Match",
      "name": "matchType",
      "type": "options",
      "default": "anyFilter",
      "options": [
        {
          "name": "Any filter",
          "value": "anyFilter"
        },
        {
          "name": "All Filters",
          "value": "allFilters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Field",
              "name": "field",
              "type": "options",
              "typeOptions": {
                "loadOptionsMethod": "getFilterableProductAttributes"
              },
              "default": ""
            },
            {
              "displayName": "Condition Type",
              "name": "condition_type",
              "type": "options",
              "options": [
                {
                  "name": "Equals",
                  "value": "eq"
                },
                {
                  "name": "Greater than",
                  "value": "gt"
                },
                {
                  "name": "Greater than or equal",
                  "value": "gteq"
                },
                {
                  "name": "In",
                  "value": "in",
                  "description": "The value can contain a comma-separated list of values"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                },
                {
                  "name": "Less Than or Equal",
                  "value": "lte"
                },
                {
                  "name": "Like",
                  "value": "like",
                  "description": "The value can contain the SQL wildcard characters when like is specified"
                },
                {
                  "name": "More or Equal",
                  "value": "moreq"
                },
                {
                  "name": "Not Equal",
                  "value": "neq"
                },
                {
                  "name": "Not In",
                  "value": "nin",
                  "description": "The value can contain a comma-separated list of values"
                },
                {
                  "name": "Not Null",
                  "value": "notnull"
                },
                {
                  "name": "Null",
                  "value": "null"
                }
              ],
              "default": "eq"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "displayOptions": {
                "hide": {
                  "condition_type": [
                    "null",
                    "notnull"
                  ]
                }
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "See <a href=\"https://devdocs.magento.com/guides/v2.4/rest/performing-searches.html\" target=\"_blank\">Magento guide</a> to creating filters",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Filters (JSON)",
      "name": "filterJson",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "fixedCollection",
          "placeholder": "Add Sort",
          "typeOptions": {
            "multipleValues": true
          },
          "default": [],
          "options": [
            {
              "displayName": "Sort",
              "name": "sort",
              "values": [
                {
                  "displayName": "Direction",
                  "name": "direction",
                  "type": "options",
                  "options": [
                    {
                      "name": "Ascending",
                      "value": "ASC"
                    },
                    {
                      "name": "Descending",
                      "value": "DESC"
                    }
                  ],
                  "default": "ASC",
                  "description": "The sorting direction"
                },
                {
                  "displayName": "Field",
                  "name": "field",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getSortableProductAttributes"
                  },
                  "default": "",
                  "description": "The sorting field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new customer"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a customer"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a customer"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many customers"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a customer"
    }
  ]


node_type: nodes-base.mailcheck
package_name: n8n-nodes-base
display_name: Mailcheck
description: Consume Mailcheck API
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "check",
  "name": "Check"
  }
  ]

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

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailcheck node documentation
  description: Learn how to use the Mailcheck node in n8n. Follow technical documentation to integrate Mailcheck node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailcheck node

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

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

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

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

  ## Operations

  * Email
      * Check

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "check",
      "options": [
        {
          "name": "Check",
          "value": "check",
          "action": "Check an email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address to check",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "check"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mailchimp
package_name: n8n-nodes-base
display_name: Mailchimp
description: Consume Mailchimp API
category: output
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailchimp node documentation
  description: Learn how to use the Mailchimp node in n8n. Follow technical documentation to integrate Mailchimp node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailchimp node

  Use the Mailchimp node to automate work in Mailchimp, and integrate Mailchimp with other applications. n8n has built-in support for a wide range of Mailchimp features, including creating, updating, and deleting campaigns, as well as getting list groups. 

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

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

  ## Operations

  * Campaign
      * Delete a campaign
      * Get a campaign
      * Get all the campaigns
      * Replicate a campaign
      * Creates a Resend to Non-Openers version of this campaign
      * Send a campaign
  * List Group
      * Get all groups
  * Member
      * Create a new member on list
      * Delete a member on list
      * Get a member on list
      * Get all members on list
      * Update a new member on list
  * Member Tag
      * Add tags from a list member
      * Remove tags from a list member

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiKey",
      "options": [
        {
          "name": "API Key",
          "value": "apiKey"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "member",
      "options": [
        {
          "name": "Campaign",
          "value": "campaign"
        },
        {
          "name": "List Group",
          "value": "listGroup"
        },
        {
          "name": "Member",
          "value": "member"
        },
        {
          "name": "Member Tag",
          "value": "memberTag"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new member on list",
          "action": "Create a member"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a member on list",
          "action": "Delete a member"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a member on list",
          "action": "Get a member"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members on a list",
          "action": "Get many members"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a new member on list",
          "action": "Update a member"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Add tags from a list member",
          "action": "Create a member tag"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Remove tags from a list member",
          "action": "Delete a member tag"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "memberTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many groups",
          "action": "Get many list groups"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "listGroup"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a campaign",
          "action": "Delete a campaign"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a campaign",
          "action": "Get a campaign"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many campaigns",
          "action": "Get many campaigns"
        },
        {
          "name": "Replicate",
          "value": "replicate",
          "description": "Replicate a campaign",
          "action": "Replicate a campaign"
        },
        {
          "name": "Resend",
          "value": "resend",
          "description": "Creates a Resend to Non-Openers version of this campaign",
          "action": "Resend a campaign"
        },
        {
          "name": "Send",
          "value": "send",
          "description": "Send a campaign",
          "action": "Send a campaign"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address for a subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Status",
      "name": "status",
      "type": "options",
      "default": "",
      "description": "Subscriber's current status",
      "options": [
        {
          "name": "Cleaned",
          "value": "cleaned"
        },
        {
          "name": "Pending",
          "value": "pending"
        },
        {
          "name": "Subscribed",
          "value": "subscribed"
        },
        {
          "name": "Transactional",
          "value": "transactional"
        },
        {
          "name": "Unsubscribed",
          "value": "unsubscribed"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email Type",
          "name": "emailType",
          "type": "options",
          "options": [
            {
              "name": "HTML",
              "value": "html"
            },
            {
              "name": "Text",
              "value": "text"
            }
          ],
          "default": "",
          "description": "Type of email this member asked to get"
        },
        {
          "displayName": "Language",
          "name": "language",
          "type": "string",
          "default": "",
          "description": "If set/detected, the subscriber's language"
        },
        {
          "displayName": "Opt-in IP",
          "name": "ipOptIn",
          "type": "string",
          "default": "",
          "description": "The IP address the subscriber used to confirm their opt-in status"
        },
        {
          "displayName": "Signup IP",
          "name": "ipSignup",
          "type": "string",
          "default": "",
          "description": "IP address the subscriber signed up from"
        },
        {
          "displayName": "Signup Timestamp",
          "name": "timestampSignup",
          "type": "dateTime",
          "default": "",
          "description": "The date and time the subscriber signed up for the list in ISO 8601 format"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "The tags that are associated with a member separeted by ,"
        },
        {
          "displayName": "Vip",
          "name": "vip",
          "type": "boolean",
          "default": false,
          "description": "Vip status for subscribers"
        },
        {
          "displayName": "Opt-in Timestamp",
          "name": "timestampOpt",
          "type": "dateTime",
          "default": "",
          "description": "The date and time the subscribe confirmed their opt-in status in ISO 8601 format"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Location",
      "name": "locationFieldsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Subscriber location information.n",
      "options": [
        {
          "name": "locationFieldsValues",
          "displayName": "Location",
          "values": [
            {
              "displayName": "Latitude",
              "name": "latitude",
              "type": "string",
              "required": true,
              "description": "The location latitude",
              "default": ""
            },
            {
              "displayName": "Longitude",
              "name": "longitude",
              "type": "string",
              "required": true,
              "description": "The location longitude",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Merge Fields",
      "name": "mergeFieldsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "An individual merge var and value for a member",
      "options": [
        {
          "name": "mergeFieldsValues",
          "displayName": "Field",
          "typeOptions": {
            "multipleValueButtonText": "Add Field"
          },
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "name",
              "type": "options",
              "typeOptions": {
                "loadOptionsMethod": "getMergeFields",
                "loadOptionsDependsOn": [
                  "list"
                ]
              },
              "required": true,
              "description": "Merge Field name. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "value",
              "required": true,
              "type": "string",
              "default": "",
              "description": "Merge field value"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Merge Fields",
      "name": "mergeFieldsJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Location",
      "name": "locationJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Interest Groups",
      "name": "groupsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "groupsValues",
          "displayName": "Group",
          "typeOptions": {
            "multipleValueButtonText": "Add Interest Group"
          },
          "values": [
            {
              "displayName": "Category Name or ID",
              "name": "categoryId",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getGroupCategories",
                "loadOptionsDependsOn": [
                  "list"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Category Field ID",
              "name": "categoryFieldId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Interest Groups",
      "name": "groupJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Member's email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Member's email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of fields to return"
        },
        {
          "displayName": "Exclude Fields",
          "name": "excludeFields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of fields to exclude"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "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": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 500,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Before Last Changed",
          "name": "beforeLastChanged",
          "type": "dateTime",
          "default": "",
          "description": "Restrict results to subscribers whose information changed before the set timeframe"
        },
        {
          "displayName": "Before Timestamp Opt",
          "name": "beforeTimestampOpt",
          "type": "dateTime",
          "default": "",
          "description": "Restrict results to subscribers who opted-in before the set timeframe"
        },
        {
          "displayName": "Email Type",
          "name": "emailType",
          "type": "options",
          "options": [
            {
              "name": "HTML",
              "value": "html"
            },
            {
              "name": "Text",
              "value": "text"
            }
          ],
          "default": "",
          "description": "Type of email this member asked to get"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Cleaned",
              "value": "cleaned"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Subscribed",
              "value": "subscribed"
            },
            {
              "name": "Transactional",
              "value": "transactional"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": "",
          "description": "Subscriber's current status"
        },
        {
          "displayName": "Since Last Changed",
          "name": "sinceLastChanged",
          "type": "dateTime",
          "default": "",
          "description": "Restrict results to subscribers whose information changed after the set timeframe"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email Type",
          "name": "emailType",
          "type": "options",
          "options": [
            {
              "name": "HTML",
              "value": "html"
            },
            {
              "name": "Text",
              "value": "text"
            }
          ],
          "default": "",
          "description": "Type of email this member asked to get"
        },
        {
          "displayName": "Interest Groups",
          "name": "groupsUi",
          "placeholder": "Add Interest Group",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "displayOptions": {
            "show": {
              "/resource": [
                "member"
              ],
              "/operation": [
                "update"
              ],
              "/jsonParameters": [
                false
              ]
            }
          },
          "options": [
            {
              "name": "groupsValues",
              "displayName": "Group",
              "typeOptions": {
                "multipleValueButtonText": "Add Interest Group"
              },
              "values": [
                {
                  "displayName": "Category Name or ID",
                  "name": "categoryId",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "typeOptions": {
                    "loadOptionsMethod": "getGroupCategories",
                    "loadOptionsDependsOn": [
                      "list"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Category Field ID",
                  "name": "categoryFieldId",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "boolean",
                  "default": false
                }
              ]
            }
          ]
        },
        {
          "displayName": "Language",
          "name": "language",
          "type": "string",
          "default": "",
          "description": "If set/detected, the subscriber's language"
        },
        {
          "displayName": "Merge Fields",
          "name": "mergeFieldsUi",
          "placeholder": "Add Merge Fields",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "displayOptions": {
            "show": {
              "/resource": [
                "member"
              ],
              "/operation": [
                "update"
              ],
              "/jsonParameters": [
                false
              ]
            }
          },
          "description": "An individual merge var and value for a member",
          "options": [
            {
              "name": "mergeFieldsValues",
              "displayName": "Field",
              "typeOptions": {
                "multipleValueButtonText": "Add Field"
              },
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getMergeFields",
                    "loadOptionsDependsOn": [
                      "list"
                    ]
                  },
                  "required": true,
                  "description": "Merge Field name. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "default": ""
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "required": true,
                  "type": "string",
                  "default": "",
                  "description": "Merge field value"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Opt-in IP",
          "name": "ipOptIn",
          "type": "string",
          "default": "",
          "description": "The IP address the subscriber used to confirm their opt-in status"
        },
        {
          "displayName": "Signup IP",
          "name": "ipSignup",
          "type": "string",
          "default": "",
          "description": "IP address the subscriber signed up from"
        },
        {
          "displayName": "Signup Timestamp",
          "name": "timestampSignup",
          "type": "dateTime",
          "default": "",
          "description": "The date and time the subscriber signed up for the list in ISO 8601 format"
        },
        {
          "displayName": "Skip Merge Validation",
          "name": "skipMergeValidation",
          "type": "boolean",
          "default": false,
          "description": "Whether member data will be accepted without merge field values, even if the merge field is usually required"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Cleaned",
              "value": "cleaned"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Subscribed",
              "value": "subscribed"
            },
            {
              "name": "Transactional",
              "value": "transactional"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": "",
          "description": "Subscriber's current status"
        },
        {
          "displayName": "Vip",
          "name": "vip",
          "type": "boolean",
          "default": false,
          "description": "Vip status for subscribers"
        },
        {
          "displayName": "Location",
          "name": "locationFieldsUi",
          "type": "fixedCollection",
          "placeholder": "Add Location",
          "default": {},
          "description": "Subscriber location information.n",
          "displayOptions": {
            "show": {
              "/resource": [
                "member"
              ],
              "/operation": [
                "update"
              ],
              "/jsonParameters": [
                false
              ]
            }
          },
          "options": [
            {
              "name": "locationFieldsValues",
              "displayName": "Location",
              "values": [
                {
                  "displayName": "Latitude",
                  "name": "latitude",
                  "type": "string",
                  "required": true,
                  "description": "The location latitude",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "longitude",
                  "type": "string",
                  "required": true,
                  "description": "The location longitude",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Opt-in Timestamp",
          "name": "timestampOpt",
          "type": "dateTime",
          "default": "",
          "description": "The date and time the subscribe confirmed their opt-in status in ISO 8601 format"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Merge Fields",
      "name": "mergeFieldsJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Location",
      "name": "locationJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Interest Groups",
      "name": "groupJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "memberTag"
          ],
          "operation": [
            "create",
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "memberTag"
          ],
          "operation": [
            "create",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Tags",
      "name": "tags",
      "type": "string",
      "default": [],
      "displayOptions": {
        "show": {
          "resource": [
            "memberTag"
          ],
          "operation": [
            "create",
            "delete"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Tag"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Is Syncing",
          "name": "isSyncing",
          "type": "boolean",
          "default": false,
          "description": "Whether automations based on the tags in the request will not fire"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "memberTag"
          ],
          "operation": [
            "create",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "listGroup"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Group Category Name or ID",
      "name": "groupCategory",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "listGroup"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGroupCategories",
        "loadOptionsDependsOn": [
          "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": [
            "listGroup"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 500,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "listGroup"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "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": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Before Create Time",
          "name": "beforeCreateTime",
          "type": "dateTime",
          "default": "",
          "description": "Restrict the response to campaigns created before the set time"
        },
        {
          "displayName": "Before Send Time",
          "name": "beforeSendTime",
          "type": "dateTime",
          "default": "",
          "description": "Restrict the response to campaigns sent before the set time"
        },
        {
          "displayName": "Exclude Field Names or IDs",
          "name": "excludeFields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCampaignsFields"
          },
          "default": [],
          "description": "A comma-separated list of fields to exclude. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Field Names or IDs",
          "name": "fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCampaignsFields"
          },
          "default": [
            "campaigns.id",
            "campaigns.status",
            "campaigns.tracking",
            "campaigns.settings.from_name",
            "campaigns.settings.reply_to",
            "campaigns.settings.title"
          ],
          "description": "A comma-separated list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "List Name or ID",
          "name": "listId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getLists"
          },
          "default": "",
          "description": "List of lists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Since Create Time",
          "name": "sinceCreateTime",
          "type": "dateTime",
          "default": "",
          "description": "Restrict the response to campaigns created after the set time"
        },
        {
          "displayName": "Since Send Time",
          "name": "sinceSendTime",
          "type": "dateTime",
          "default": "",
          "description": "Restrict the response to campaigns sent after the set time"
        },
        {
          "displayName": "Sort Direction",
          "name": "sortDirection",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "ASC"
            },
            {
              "name": "DESC",
              "value": "DESC"
            }
          ],
          "default": "",
          "description": "Determines the order direction for sorted results"
        },
        {
          "displayName": "Sort Field",
          "name": "sortField",
          "type": "options",
          "options": [
            {
              "name": "Create Time",
              "value": "create_time"
            },
            {
              "name": "Send Time",
              "value": "send_time"
            }
          ],
          "default": "",
          "description": "Returns files sorted by the specified field"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Save",
              "value": "save"
            },
            {
              "name": "Sending",
              "value": "sending"
            },
            {
              "name": "Sent",
              "value": "sent"
            },
            {
              "name": "Schedule",
              "value": "schedule"
            }
          ],
          "default": "",
          "description": "The status of the campaign"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Campaign ID",
      "name": "campaignId",
      "type": "string",
      "default": "",
      "description": "List of Campaigns",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "send",
            "get",
            "delete",
            "replicate",
            "resend"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new member on list"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a member on list"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a member on list"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many members on a list"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a new member on list"
    }
  ]

credentials_required:
  [
    {
      "name": "mailchimpApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiKey"
          ]
        }
      }
    },
    {
      "name": "mailchimpOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mailchimpTrigger
package_name: n8n-nodes-base
display_name: Mailchimp Trigger
description: Handle Mailchimp events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailchimp Trigger node documentation
  description: Learn how to use the Mailchimp Trigger node in n8n. Follow technical documentation to integrate Mailchimp Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailchimp Trigger node

  [Mailchimp](https://mailchimp.com/){:target=_blank .external-link} is an integrated marketing platform that allows business owners to automate their email campaigns and track user engagement.

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiKey",
      "options": [
        {
          "name": "API Key",
          "value": "apiKey"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "The list that is gonna fire the event. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events that can trigger the webhook and whether they are enabled",
      "options": [
        {
          "name": "Campaign Sent",
          "value": "campaign",
          "description": "Whether the webhook is triggered when a campaign is sent or cancelled"
        },
        {
          "name": "Cleaned",
          "value": "cleaned",
          "description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list"
        },
        {
          "name": "Email Address Updated",
          "value": "upemail",
          "description": "Whether the webhook is triggered when a subscriber's email address is changed"
        },
        {
          "name": "Profile Updated",
          "value": "profile",
          "description": "Whether the webhook is triggered when a subscriber's profile is updated"
        },
        {
          "name": "Subscribe",
          "value": "subscribe",
          "description": "Whether the webhook is triggered when a list subscriber is added"
        },
        {
          "name": "Unsubscribe",
          "value": "unsubscribe",
          "description": "Whether the webhook is triggered when a list member unsubscribes"
        }
      ],
      "required": true
    },
    {
      "displayName": "Sources",
      "name": "sources",
      "type": "multiOptions",
      "default": [],
      "description": "The possible sources of any events that can trigger the webhook and whether they are enabled",
      "options": [
        {
          "name": "User",
          "value": "user",
          "description": "Whether the webhook is triggered by subscriber-initiated actions"
        },
        {
          "name": "Admin",
          "value": "admin",
          "description": "Whether the webhook is triggered by admin-initiated actions in the web interface"
        },
        {
          "name": "API",
          "value": "api",
          "description": "Whether the webhook is triggered by actions initiated via the API"
        }
      ],
      "required": true
    }
  ]

credentials_required:
  [
    {
      "name": "mailchimpApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiKey"
          ]
        }
      }
    },
    {
      "name": "mailchimpOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MailerLite node documentation
  description: Learn how to use the MailerLite node in n8n. Follow technical documentation to integrate MailerLite node into your workflows.
  contentType: [integration, reference]
  ---

  # MailerLite node

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

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

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

  ## Operations

  * Subscriber
      * Create a new subscriber
      * Get an subscriber
      * Get all subscribers
      * Update an subscriber

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "subscriber",
      "options": [
        {
          "name": "Subscriber",
          "value": "subscriber"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new subscriber",
          "action": "Create a subscriber"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an subscriber",
          "action": "Get a subscriber"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many subscribers",
          "action": "Get many subscribers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an subscriber",
          "action": "Update a subscriber"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of new subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Filter by custom fields",
          "default": {},
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Bounced",
              "value": "bounced"
            },
            {
              "name": "Junk",
              "value": "junk"
            },
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Subscribed At",
          "name": "subscribed_at",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "IP Address",
          "name": "ip_address",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Opted In At",
          "name": "opted_in_at",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Opt In IP",
          "name": "optin_ip",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Unsubscribed At",
          "name": "unsubscribed_at",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "update",
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "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": [
            "subscriber"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Bounced",
              "value": "bounced"
            },
            {
              "name": "Junk",
              "value": "junk"
            },
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "subscriber"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new subscriber"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an subscriber"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many subscribers"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an subscriber"
    }
  ]


node_type: nodes-base.mailerLiteTrigger
package_name: n8n-nodes-base
display_name: MailerLite Trigger
description: Starts the workflow when MailerLite events occur
category: trigger
development_style: programmatic
version: 2
operations: []
credentials_required:
  [
  {
  "name": "mailerLiteApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MailerLite Trigger node documentation
  description: Learn how to use the MailerLite Trigger node in n8n. Follow technical documentation to integrate MailerLite Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # MailerLite Trigger node

  [MailerLite](https://www.mailerlite.com/){:target=_blank .external-link} is an email marketing solution that provides you with a user-friendly content editor, simplified subscriber management, and campaign reports with the most important statistics.

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

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

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

  ## Events

  - Campaign Sent
  - Subscriber Added to Group
  - Subscriber Automation Completed
  - Subscriber Automation Triggered
  - Subscriber Bounced
  - Subscriber Created
  - Subscriber Complained
  - Subscriber Removed from Group
  - Subscriber Unsubscribe
  - Subscriber Updated

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events to listen to",
      "options": [
        {
          "name": "Campaign Sent",
          "value": "campaign.sent",
          "description": "Fired when campaign is sent"
        },
        {
          "name": "Subscriber Added to Group",
          "value": "subscriber.added_to_group",
          "description": "Fired when a subscriber is added to a group"
        },
        {
          "name": "Subscriber Automation Completed",
          "value": "subscriber.automation_completed",
          "description": "Fired when subscriber finishes automation"
        },
        {
          "name": "Subscriber Automation Triggered",
          "value": "subscriber.automation_triggered",
          "description": "Fired when subscriber starts automation"
        },
        {
          "name": "Subscriber Bounced",
          "value": "subscriber.bounced",
          "description": "Fired when an email address bounces"
        },
        {
          "name": "Subscriber Created",
          "value": "subscriber.created",
          "description": "Fired when a new subscriber is added to an account"
        },
        {
          "name": "Subscriber Removed From Group",
          "value": "subscriber.removed_from_group",
          "description": "Fired when a subscriber is removed from a group"
        },
        {
          "name": "Subscriber Spam Reported",
          "value": "subscriber.spam_reported",
          "description": "Fired when subscriber marks a campaign as a spam"
        },
        {
          "name": "Subscriber Unsubscribe",
          "value": "subscriber.unsubscribed",
          "description": "Fired when a subscriber becomes unsubscribed"
        },
        {
          "name": "Subscriber Updated",
          "value": "subscriber.updated",
          "description": "Fired when any of the subscriber's custom fields are updated"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.mailgun
package_name: n8n-nodes-base
display_name: Mailgun
description: Sends an email via Mailgun
category: output
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mailgunApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailgun node documentation
  description: Learn how to use the Mailgun node in n8n. Follow technical documentation to integrate Mailgun node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailgun node

  Use the Mailgun node to automate work in Mailgun, and integrate Mailgun with other applications. n8n has built-in support for sending emails with Mailgun. 

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

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

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

  ## Operations

  - Send an email

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender optional with name",
      "required": true
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true
    },
    {
      "displayName": "Cc Email",
      "name": "ccEmail",
      "type": "string",
      "default": "",
      "description": "Cc Email address of the recipient. Multiple ones can be separated by comma."
    },
    {
      "displayName": "Bcc Email",
      "name": "bccEmail",
      "type": "string",
      "default": "",
      "description": "Bcc Email address of the recipient. Multiple ones can be separated by comma."
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email"
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "typeOptions": {
        "rows": 5,
        "editor": "htmlEditor"
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "string",
      "default": "",
      "description": "Name of the binary properties which contain data which should be added to email as attachment. Multiple ones can be comma-separated."
    }
  ]


node_type: nodes-base.mailjet
package_name: n8n-nodes-base
display_name: Mailjet
description: Consume Mailjet API
category: output
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailjet node documentation
  description: Learn how to use the Mailjet node in n8n. Follow technical documentation to integrate Mailjet node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailjet node

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

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

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

  ## Operations

  * Email
      * Send an email
      * Send an email template
  * SMS
      * Send an SMS

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "SMS",
          "value": "sms"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send a email",
          "action": "Send an email"
        },
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "description": "Send a email template",
          "action": "Send an email template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The title for the email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email"
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Email",
          "name": "bccEmail",
          "type": "string",
          "description": "Bcc Email address of the recipient. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Cc Addresses",
          "name": "ccAddresses",
          "type": "string",
          "description": "Cc Email address of the recipient. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "number",
          "default": 2
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "description": "The reply-to email address. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Template Language",
          "name": "templateLanguage",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "options",
          "options": [
            {
              "name": "Account Default",
              "value": "account_default",
              "description": "Use the values specified in the Mailjet account"
            },
            {
              "name": "Disabled",
              "value": "disabled",
              "description": "Disable tracking for this message"
            },
            {
              "name": "Enabled",
              "value": "enabled",
              "description": "Enable tracking for this message"
            }
          ],
          "description": "Enable or disable open tracking on this message",
          "default": "account_default"
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "options",
          "options": [
            {
              "name": "Account Default",
              "value": "account_default",
              "description": "Use the values specified in the Mailjet account"
            },
            {
              "name": "Disabled",
              "value": "disabled",
              "description": "Disable tracking for this message"
            },
            {
              "name": "Enabled",
              "value": "enabled",
              "description": "Enable tracking for this message"
            }
          ],
          "description": "Enable or disable open tracking on this message",
          "default": "account_default"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Variables (JSON)",
      "name": "variablesJson",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Variables",
      "name": "variablesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "variablesValues",
          "displayName": "Variable",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The title for the email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "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": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Email",
          "name": "bccEmail",
          "type": "string",
          "description": "BCC Recipients of the email separated by ,",
          "default": ""
        },
        {
          "displayName": "Cc Email",
          "name": "ccEmail",
          "type": "string",
          "description": "Cc recipients of the email separated by ,",
          "default": ""
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "number",
          "default": 2
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "description": "The reply-to email address. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Template Language",
          "name": "templateLanguage",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "string",
          "description": "Enable or disable open tracking on this message",
          "default": ""
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "string",
          "description": "Enable or disable open tracking on this message",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Variables",
      "name": "variablesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "variablesValues",
          "displayName": "Variable",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Variables (JSON)",
      "name": "variablesJson",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send a sms",
          "action": "Send an SMS"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From",
      "name": "from",
      "type": "string",
      "default": "",
      "description": "Customizable sender name. Should be between 3 and 11 characters in length, only alphanumeric characters are allowed.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To",
      "name": "to",
      "type": "string",
      "default": "",
      "description": "Message recipient. Should be between 3 and 15 characters in length. The number always starts with a plus sign followed by a country code, followed by the number. Phone numbers are expected to comply with the E.164 format.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send",
      "description": "Send a email"
    },
    {
      "operation": "sendTemplate",
      "name": "Send Template",
      "description": "Send a email template"
    }
  ]

credentials_required:
  [
    {
      "name": "mailjetEmailApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      }
    },
    {
      "name": "mailjetSmsApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mailjetTrigger
package_name: n8n-nodes-base
display_name: Mailjet Trigger
description: Handle Mailjet events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mailjetEmailApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailjet Trigger node documentation
  description: Learn how to use the Mailjet Trigger node in n8n. Follow technical documentation to integrate Mailjet Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailjet Trigger node

  [Mailjet](https://www.mailjet.com/){:target=_blank .external-link} is a cloud-based email sending and tracking system. The platform allows professionals to send both marketing emails and transactional emails. It includes tools for designing emails, sending massive volumes and tracking these messages.

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

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

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "open",
      "description": "Determines which resource events the webhook is triggered for",
      "options": [
        {
          "name": "email.blocked",
          "value": "blocked"
        },
        {
          "name": "email.bounce",
          "value": "bounce"
        },
        {
          "name": "email.open",
          "value": "open"
        },
        {
          "name": "email.sent",
          "value": "sent"
        },
        {
          "name": "email.spam",
          "value": "spam"
        },
        {
          "name": "email.unsub",
          "value": "unsub"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.mandrill
package_name: n8n-nodes-base
display_name: Mandrill
description: Consume Mandrill API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mandrillApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mandrill node documentation
  description: Learn how to use the Mandrill node in n8n. Follow technical documentation to integrate Mandrill node into your workflows.
  contentType: [integration, reference]
  ---

  # Mandrill node

  Use the Mandrill node to automate work in Mandrill, and integrate Mandrill with other applications. n8n supports sending messages based on templates or HTML with Mandrill.

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

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

  ## Operations

  * Message
      * Send message based on template.
      * Send message based on HTML.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Message",
          "value": "message",
          "description": "Send a message"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "sendTemplate",
      "options": [
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "description": "Send message based on template",
          "action": "Send a message based on a template"
        },
        {
          "name": "Send HTML",
          "value": "sendHtml",
          "description": "Send message based on HTML",
          "action": "Send a message based on HTML"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template Name or ID",
      "name": "template",
      "type": "options",
      "default": "",
      "description": "The template you want to send. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender optional with name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Async",
          "name": "async",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of \"queued\" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async."
        },
        {
          "displayName": "Auto Text",
          "name": "autoText",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically generate a text part for messages that are not given text"
        },
        {
          "displayName": "Auto HTML",
          "name": "autoHtml",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically generate an HTML part for messages that are not given HTML"
        },
        {
          "displayName": "BCC Address",
          "name": "bccAddress",
          "type": "string",
          "default": "",
          "placeholder": "message.bcc_address@example.com",
          "description": "An optional address to receive an exact copy of each recipient's email"
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": "",
          "placeholder": "John Doe",
          "description": "Optional from name to be used"
        },
        {
          "displayName": "Google Analytics Campaign",
          "name": "googleAnalyticsCampaign",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead."
        },
        {
          "displayName": "Google Analytics Domains",
          "name": "googleAnalyticsDomains",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "An array of strings separated by a comma (,) indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically"
        },
        {
          "displayName": "HTML",
          "name": "html",
          "type": "string",
          "default": "",
          "typeOptions": {
            "rows": 5
          },
          "options": [],
          "description": "The html you want to send"
        },
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether or not this message is important, and should be delivered ahead of non-important messages"
        },
        {
          "displayName": "Inline CSS",
          "name": "inlineCss",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size"
        },
        {
          "displayName": "Ip Pool",
          "name": "ipPool",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead."
        },
        {
          "displayName": "Preserve Recipients",
          "name": "preserveRecipients",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to expose all recipients in to \"To\" header for each email"
        },
        {
          "displayName": "Return Path Domain",
          "name": "returnPathDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for the messages's return-path"
        },
        {
          "displayName": "Sent At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance."
        },
        {
          "displayName": "Signing Domain",
          "name": "signingDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for SPF/DKIM signing instead of mandrill(for \"via\" or \"on behalf of\" in email clients)"
        },
        {
          "displayName": "Subaccount",
          "name": "subAccount",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The unique ID of a subaccount for this message - must already exist or will fail with an error"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": "",
          "placeholder": "My subject line",
          "description": "Subject line of the email"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "An array of string separated by a comma (,) to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors."
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "typeOptions": {
            "rows": 5
          },
          "options": [],
          "description": "Example text content"
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to turn on click tracking for the message"
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to turn on open tracking for the message"
        },
        {
          "displayName": "Tracking Domain",
          "name": "trackingDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for tracking opens and clicks instead of mandrillapp.com"
        },
        {
          "displayName": "Url Strip Qs",
          "name": "urlStripQs",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to strip the query string from URLs when aggregating tracked URL data"
        },
        {
          "displayName": "View Content Link",
          "name": "viewContentLink",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove content logging for sensitive emails"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Merge Vars",
      "name": "mergeVarsJson",
      "type": "json",
      "default": "",
      "description": "Global merge variables",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Merge Vars",
      "name": "mergeVarsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Per-recipient merge variables",
      "options": [
        {
          "name": "mergeVarsValues",
          "displayName": "Vars",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "Name of the metadata key to add."
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataJson",
      "type": "json",
      "default": "",
      "description": "Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsJson",
      "type": "json",
      "default": "",
      "description": "An array of supported attachments to add to the message",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Array of supported attachments to add to the message",
      "options": [
        {
          "name": "attachmentsValues",
          "displayName": "Attachments Values",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "string",
              "default": "",
              "placeholder": "text/plain",
              "description": "The MIME type of the attachment"
            },
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "placeholder": "myfile.txt",
              "description": "The file name of the attachment"
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": "",
              "placeholder": "ZXhhbXBsZSBmaWxl",
              "description": "The content of the attachment as a base64-encoded string"
            }
          ]
        },
        {
          "name": "attachmentsBinary",
          "displayName": "Attachments Binary",
          "values": [
            {
              "displayName": "Property",
              "name": "property",
              "type": "string",
              "default": "",
              "description": "Name of the binary properties which contain data which should be added to email as attachment"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Headers",
      "name": "headersJson",
      "type": "json",
      "default": "",
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Headers",
      "name": "headersUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "options": [
        {
          "name": "headersValues",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "sendTemplate",
      "name": "Send Template",
      "description": "Send message based on template"
    },
    {
      "operation": "sendHtml",
      "name": "Send HTML",
      "description": "Send message based on HTML"
    }
  ]


node_type: nodes-base.manualTrigger
package_name: n8n-nodes-base
display_name: Manual Trigger
description: Runs the flow on clicking a button in n8n
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
properties_schema:
  [
    {
      "displayName": "This node is where the workflow execution starts (when you click the ‘test’ button on the canvas).<br><br> <a data-action=\"showNodeCreator\">Explore other ways to trigger your workflow</a> (e.g on a schedule, or a webhook)",
      "name": "notice",
      "type": "notice",
      "default": ""
    }
  ]


node_type: nodes-base.markdown
package_name: n8n-nodes-base
display_name: Markdown
description: Convert data between Markdown and HTML
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Markdown
  description: Documentation for the Markdown node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Markdown

  The Markdown node converts between Markdown and HTML formats.

  ## Operations

  This node's operations are **Modes**:

  * **Markdown to HTML**: Use this mode to convert from Markdown to HTML.
  * **HTML to Markdown**: Use this mode to convert from HTML to Markdown.

  ## Node parameters

  * **HTML** or **Markdown**: Enter the data you want to convert. The field name changes based on which **Mode** you select.
  * **Destination Key**: Enter the field you want to put the output in. Specify nested fields using dots, for example `level1.level2.newKey`.

  ## Node options

  The node's **Options** depend on the **Mode** selected.

  /// note | Test out the options
  Some of the options depend on each other or can interact. We recommend testing out options to confirm the effects are what you want.
  ///

  ### Markdown to HTML options

  | Option | Description | Default |
  | ------ | ----------- | ------- |
  | **Add Blank To Links** | Whether to open links a new window (enabled) or not (disabled). | Disabled |
  | **Automatic Linking To URLs** | Whether to automatically link to URLs (enabled) or not (disabled). If enabled, n8n converts any string that it identifies as a URL to a link. | Disabled |
  | **Backslash Escapes HTML Tags** | Whether to allow backslash escaping of HTML tags (enabled) or not (disabled). When enabled, n8n escapes any `<` or `>` prefaced with `\`. For example, `\<div\>` renders as `&lt;div&gt;`.  | Disabled |
  | **Complete HTML Document** | Whether to output a complete HTML document (enabled) or an HTML fragment (disabled). A complete HTML document includes the `<DOCTYPE HTML>` declaration, `<html>` and `<body>` tags, and the `<head>` element.  | Disabled |
  | **Customized Header ID** | Whether to support custom heading IDs (enabled) or not (disabled). When enabled, you can add custom heading IDs using `{header ID here}` after the heading text. | Disabled |
  | **Emoji Support** | Whether to support emojis (enabled) or not (disabled). | Disabled. |
  | **Encode Emails** | Whether to transform ASCII character emails into their equivalent decimal entities (enabled) or not (disabled). | Enabled | 
  | **Exclude Trailing Punctuation From URLs** | Whether to exclude trailing punctuation from automatically linked URLs (enabled) or not (disabled). For use with **Automatic Linking To URLs**. | Disabled |
  | **GitHub Code Blocks** | Whether to enable GitHub Flavored Markdown code blocks (enabled) or not (disabled). | Enabled |
  | **GitHub Compatible Header IDs** | Whether to generate GitHub Flavored Markdown heading IDs (enabled) or not (disabled). GitHub Flavored Markdown generates heading IDs with `-` in place of spaces and removes non-alphanumeric characters. | Disabled |
  | **GitHub Mention Link** | Change the link used with **GitHub Mentions**.  | Disabled |
  | **GitHub Mentions** | Whether to support tagging GitHub users with `@` (enabled) or not (disabled). When enabled, n8n replaces `@name` with `https://github.com/name`. | Disabled |
  | **GitHub Task Lists** | Whether to support GitHub Flavored Markdown task lists (enabled) or not (disabled). | Disabled |
  | **Header Level Start** | Number. Set the start level for headers. For example, changing this field to `2` causes n8n to treat `#` as `<h2>`, `##` as `<h3>`, and so on. | 1 |
  | **Mandatory Space Before Header** | Whether to make a space between `#` and heading text required (enabled) or not (disabled). When enabled, n8n renders a heading written as `##Some header text` literally (it doesn't turn it into a heading element) | Disabled |
  | **Middle Word Asterisks** | Whether n8n should treat asterisks in words as Markdown (disabled) or render them as literal asterisks (enabled). | Disabled |
  | **Middle Word Underscores** | Whether n8n should treat underscores in words as Markdown (disabled) or render them as literal underscores (enabled). | Disabled |
  | **No Header ID** | Disable automatic generation of header IDs (enabled). | Disabled |
  | **Parse Image Dimensions** | Support setting maximum image dimensions in Markdown syntax (enabled). | Disabled |
  | **Prefix Header ID** | Define a prefix to add to header IDs. | None |
  | **Raw Header ID** | Whether to remove spaces, `'`, and `"` from header IDs, including prefixes, replacing them with `-` (enabled) or not (disabled). | Disabled |
  | **Raw Prefix Header ID** | Whether to prevent n8n from modifying header prefixes (enabled) or not (disabled) | Disabled |
  | **Simple Line Breaks** | Whether to create line breaks without a double space at the end of a line (enabled) or not (disabled). | Disabled |
  | **Smart Indentation Fix** | Whether to try to smartly fix indentation problems related to ES6 template strings in indented code blocks (enabled) or not (disabled). | Disabled |
  | **Spaces Indented Sublists** | Whether to remove the requirement to indent sublists four spaces (enabled) or not (disabled). | Disabled |
  | **Split Adjacent Blockquotes** | Whether to split adjacent blockquote blocks (enabled) or not (disabled). If you don't enable this, n8n treats quotes (indicated by `>` at the start of the line) on separate lines as a single blockquote, even when separated by an empty line.  | Disabled |
  | **Strikethrough** | Whether to support strikethrough syntax (enabled) or not (disabled). When enabled, you can add a ~~strikethrough~~ effect using `~~` around the word or phrase. | Disabled |
  | **Tables Header ID** | Whether to add an ID to table header tags (enabled) or not (disabled). | Disabled |
  | **Tables Support** | Whether to support tables (enabled) or not (disabled). | Disabled |

  ### HTML to Markdown options

  | Option | Description | Default |
  | ------ | ----------- | ------- |
  | **Bullet Marker** | Specify the character to use for unordered lists. | * |
  | **Code Block Fence** | Specify the characters to use for code blocks. | ``` |
  | **Emphasis Delimiter** | Specify the character `<em>`. | _ |
  | **Global Escape Pattern** | Overrides the default character escape settings. You may want to use Text Replacement Pattern instead. | None |
  | **Ignored Elements** | Ignore given HTML elements, and their children. | None |
  | **Keep Images With Data** | Whether to keep images with data (enabled) or not (disabled). Support files up to 1MB. | Disabled |
  | **Line Start Escape Pattern** | Overrides the default character escape settings. You may want to use Text Replacement Pattern instead. | None |
  | **Max Consecutive New Lines** | Number. Specify the maximum number of consecutive new lines allowed. | 3 |
  | **Place URLs At The Bottom** | Whether to place URLs at the bottom of the page and format using link reference definitions (enabled) or not (disabled). | Disabled |
  | **Strong Delimiter** | Specify the characters for `<strong>`. | ** |
  | **Style For Code Block** | Specify the styling for code blocks. Options are **Fence** and **Indented**. | Fence |
  | **Text Replacement Pattern** | Define a text replacement pattern using regex. | None |
  | **Treat As Blocks** | Specify HTML elements to treat as blocks (surround with blank lines) | None |

  ## Templates and examples

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

  ## Parsers

  n8n uses the following parsers:

  * To convert from HTML to Markdown: [node-html-markdown](https://www.npmjs.com/package/node-html-markdown){:target=_blank .external-link}.
  * To convert from Markdown to HTML: [Showdown](https://www.npmjs.com/package/showdown){:target=_blank .external-link}. Some options allow you to extend your Markdown with [GitHub Flavored Markdown](https://github.github.com/gfm/){:target=_blank .external-link}.

properties_schema:
  [
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "htmlToMarkdown",
      "options": [
        {
          "name": "Markdown to HTML",
          "value": "markdownToHtml",
          "description": "Convert data from Markdown to HTML"
        },
        {
          "name": "HTML to Markdown",
          "value": "htmlToMarkdown",
          "description": "Convert data from HTML to Markdown"
        }
      ]
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "The HTML to be converted to markdown",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "htmlToMarkdown"
          ]
        }
      }
    },
    {
      "displayName": "Markdown",
      "name": "markdown",
      "type": "string",
      "default": "",
      "description": "The Markdown to be converted to html",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "markdownToHtml"
          ]
        }
      }
    },
    {
      "displayName": "Destination Key",
      "name": "destinationKey",
      "type": "string",
      "default": "data",
      "description": "The field to put the output in. Specify nested fields using dots, e.g.\"level1.level2.newKey\".",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "markdownToHtml",
            "htmlToMarkdown"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bullet Marker",
          "name": "bulletMarker",
          "type": "string",
          "default": "*",
          "description": "Specify bullet marker, default *"
        },
        {
          "displayName": "Code Block Fence",
          "name": "codeFence",
          "type": "string",
          "default": "```",
          "description": "Specify code block fence, default ```"
        },
        {
          "displayName": "Emphasis Delimiter",
          "name": "emDelimiter",
          "type": "string",
          "default": "_",
          "description": "Specify emphasis delimiter, default _"
        },
        {
          "displayName": "Global Escape Pattern",
          "name": "globalEscape",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "description": "Setting this will override the default escape settings, you might want to use textReplace option instead",
          "options": [
            {
              "name": "value",
              "displayName": "Value",
              "values": [
                {
                  "displayName": "Pattern",
                  "name": "pattern",
                  "type": "string",
                  "default": "",
                  "description": "RegEx for pattern"
                },
                {
                  "displayName": "Replacement",
                  "name": "replacement",
                  "type": "string",
                  "default": "",
                  "description": "String replacement"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Ignored Elements",
          "name": "ignore",
          "type": "string",
          "default": "",
          "description": "Supplied elements will be ignored (ignores inner text does not parse children)",
          "placeholder": "e.g. h1, p ...",
          "hint": "Comma separated elements"
        },
        {
          "displayName": "Keep Images With Data",
          "name": "keepDataImages",
          "type": "boolean",
          "default": false,
          "description": "Whether to keep images with data: URI (Note: These can be up to 1MB each), e.g. &lt;img src=\"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSK......0o/\"&gt;"
        },
        {
          "displayName": "Line Start Escape Pattern",
          "name": "lineStartEscape",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "description": "Setting this will override the default escape settings, you might want to use textReplace option instead",
          "options": [
            {
              "name": "value",
              "displayName": "Value",
              "values": [
                {
                  "displayName": "Pattern",
                  "name": "pattern",
                  "type": "string",
                  "default": "",
                  "description": "RegEx for pattern"
                },
                {
                  "displayName": "Replacement",
                  "name": "replacement",
                  "type": "string",
                  "default": "",
                  "description": "String replacement"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Max Consecutive New Lines",
          "name": "maxConsecutiveNewlines",
          "type": "number",
          "default": 3,
          "description": "Specify max consecutive new lines allowed"
        },
        {
          "displayName": "Place URLs At The Bottom",
          "name": "useLinkReferenceDefinitions",
          "type": "boolean",
          "default": false,
          "description": "Whether to Place URLS at the bottom and format links using link reference definitions"
        },
        {
          "displayName": "Strong Delimiter",
          "name": "strongDelimiter",
          "type": "string",
          "default": "**",
          "description": "Specify strong delimiter, default **"
        },
        {
          "displayName": "Style For Code Block",
          "name": "codeBlockStyle",
          "type": "options",
          "default": "fence",
          "description": "Specify style for code block, default \"fence\"",
          "options": [
            {
              "name": "Fence",
              "value": "fence"
            },
            {
              "name": "Indented",
              "value": "indented"
            }
          ]
        },
        {
          "displayName": "Text Replacement Pattern",
          "name": "textReplace",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": [],
          "description": "User-defined text replacement pattern (Replaces matching text retrieved from nodes)",
          "options": [
            {
              "name": "values",
              "displayName": "Values",
              "values": [
                {
                  "displayName": "Pattern",
                  "name": "pattern",
                  "type": "string",
                  "default": "",
                  "description": "RegEx for pattern"
                },
                {
                  "displayName": "Replacement",
                  "name": "replacement",
                  "type": "string",
                  "default": "",
                  "description": "String replacement"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Treat As Blocks",
          "name": "blockElements",
          "type": "string",
          "default": "",
          "description": "Supplied elements will be treated as blocks (surrounded with blank lines)",
          "placeholder": "e.g. p, div, ...",
          "hint": "Comma separated elements"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "htmlToMarkdown"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Add Blank To Links",
          "name": "openLinksInNewWindow",
          "type": "boolean",
          "default": false,
          "description": "Whether to open all links in new windows (by adding the attribute target=\"_blank\" to <a> tags)"
        },
        {
          "displayName": "Automatic Linking to URLs",
          "name": "simplifiedAutoLink",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable automatic linking to URLs"
        },
        {
          "displayName": "Backslash Escapes HTML Tags",
          "name": "backslashEscapesHTMLTags",
          "type": "boolean",
          "default": false,
          "description": "Whether to support for HTML Tag escaping ex: &lt;div&gt;foo&lt;/div&gt;"
        },
        {
          "displayName": "Complete HTML Document",
          "name": "completeHTMLDocument",
          "type": "boolean",
          "default": false,
          "description": "Whether to output a complete html document, including &lt;html&gt;, &lt;head&gt; and &lt;body&gt; tags instead of an HTML fragment"
        },
        {
          "displayName": "Customized Header ID",
          "name": "customizedHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to use text in curly braces as header ID"
        },
        {
          "displayName": "Emoji Support",
          "name": "emoji",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable emoji support. Ex: this is a :smile: emoji For more info on available emojis, see https://github.com/showdownjs/showdown/wiki/Emojis."
        },
        {
          "displayName": "Encode Emails",
          "name": "encodeEmails",
          "type": "boolean",
          "default": true,
          "description": "Whether to enable e-mail addresses encoding through the use of Character Entities, transforming ASCII e-mail addresses into its equivalent decimal entities"
        },
        {
          "displayName": "Exclude Trailing Punctuation From URLs",
          "name": "excludeTrailingPunctuationFromURLs",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude trailing punctuation from autolinking URLs. Punctuation excluded: . ! ? ( ). Only applies if simplifiedAutoLink option is set to true."
        },
        {
          "displayName": "GitHub Code Blocks",
          "name": "ghCodeBlocks",
          "type": "boolean",
          "default": true,
          "description": "Whether to enable support for GFM code block style"
        },
        {
          "displayName": "GitHub Compatible Header IDs",
          "name": "ghCompatibleHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to generate header IDs compatible with github style (spaces are replaced with dashes and a bunch of non alphanumeric chars are removed)"
        },
        {
          "displayName": "GitHub Mention Link",
          "name": "ghMentionsLink",
          "type": "string",
          "default": "https://github.com/{u}",
          "description": "Whether to change the link generated by @mentions. Showdown will replace {u} with the username. Only applies if ghMentions option is enabled."
        },
        {
          "displayName": "GitHub Mentions",
          "name": "ghMentions",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable github @mentions, which link to the username mentioned"
        },
        {
          "displayName": "GitHub Task Lists",
          "name": "tasklists",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for GFM tasklists"
        },
        {
          "displayName": "Header Level Start",
          "name": "headerLevelStart",
          "type": "number",
          "default": 1,
          "description": "Whether to set the header starting level"
        },
        {
          "displayName": "Mandatory Space Before Header",
          "name": "requireSpaceBeforeHeadingText",
          "type": "boolean",
          "default": false,
          "description": "Whether to make adding a space between # and the header text mandatory"
        },
        {
          "displayName": "Middle Word Asterisks",
          "name": "literalMidWordAsterisks",
          "type": "boolean",
          "default": false,
          "description": "Whether to stop showdown from interpreting asterisks in the middle of words as <em> and <strong> and instead treat them as literal asterisks"
        },
        {
          "displayName": "Middle Word Underscores",
          "name": "literalMidWordUnderscores",
          "type": "boolean",
          "default": false,
          "description": "Whether to stop showdown from interpreting underscores in the middle of words as <em> and <strong> and instead treat them as literal underscores"
        },
        {
          "displayName": "No Header ID",
          "name": "noHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to disable the automatic generation of header IDs"
        },
        {
          "displayName": "Parse Image Dimensions",
          "name": "parseImgDimensions",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for setting image dimensions from within markdown syntax"
        },
        {
          "displayName": "Prefix Header ID",
          "name": "prefixHeaderId",
          "type": "string",
          "default": "section",
          "description": "Add a prefix to the generated header IDs"
        },
        {
          "displayName": "Raw Header ID",
          "name": "rawHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove only spaces, ' and \" from generated header IDs (including prefixes), replacing them with dashes (-)"
        },
        {
          "displayName": "Raw Prefix Header ID",
          "name": "rawPrefixHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to prevent showdown from modifying the prefix"
        },
        {
          "displayName": "Simple Line Breaks",
          "name": "simpleLineBreaks",
          "type": "boolean",
          "default": false,
          "description": "Whether to parse line breaks as &lt;br&gt;, like GitHub does, without needing 2 spaces at the end of the line"
        },
        {
          "displayName": "Smart Indentation Fix",
          "name": "smartIndentationFix",
          "type": "boolean",
          "default": false,
          "description": "Whether to try to smartly fix indentation problems related to es6 template strings in the midst of indented code"
        },
        {
          "displayName": "Spaces Indented Sublists",
          "name": "disableForced4SpacesIndentedSublists",
          "type": "boolean",
          "default": false,
          "description": "Whether to disable the requirement of indenting sublists by 4 spaces for them to be nested, effectively reverting to the old behavior where 2 or 3 spaces were enough"
        },
        {
          "displayName": "Split Adjacent Blockquotes",
          "name": "splitAdjacentBlockquotes",
          "type": "boolean",
          "default": false,
          "description": "Whether to split adjacent blockquote blocks"
        },
        {
          "displayName": "Strikethrough",
          "name": "strikethrough",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for strikethrough syntax"
        },
        {
          "displayName": "Tables Header ID",
          "name": "tablesHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to add an ID property to table headers tags"
        },
        {
          "displayName": "Tables Support",
          "name": "tables",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for tables syntax"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "markdownToHtml"
          ]
        }
      }
    }
  ]


node_type: nodes-base.marketstack
package_name: n8n-nodes-base
display_name: Marketstack
description: Consume Marketstack API
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "getAll",
  "name": "Get Many"
  }
  ]

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

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: marketstack node documentation
  description: Learn how to use the marketstack node in n8n. Follow technical documentation to integrate marketstack node into your workflows.
  contentType: [integration, reference]
  ---
  <!-- marketstack is not a typo. The brand name is all lowercase, so we match it -->
  # marketstack node

  Use the marketstack node to automate work in marketstack, and integrate marketstack with other applications. n8n has built-in support for a wide range of marketstack features, including getting exchanges, end-of-day data, and tickers. 

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

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

  ## Operations

  * End-of-Day Data
      * Get All
  * Exchange
      * Get
  * Ticker
      * Get

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "endOfDayData",
      "options": [
        {
          "name": "End-of-Day Data",
          "value": "endOfDayData",
          "description": "Stock market closing data"
        },
        {
          "name": "Exchange",
          "value": "exchange",
          "description": "Stock market exchange"
        },
        {
          "name": "Ticker",
          "value": "ticker",
          "description": "Stock market symbol"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many EoD data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticker",
      "name": "symbols",
      "type": "string",
      "default": "",
      "description": "One or multiple comma-separated stock symbols (tickers) to retrieve, e.g. <code>AAPL</code> or <code>AAPL,MSFT</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "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": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exchange",
          "name": "exchange",
          "type": "string",
          "default": "",
          "description": "Stock exchange to filter results by, specified by <a href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">Market Identifier Code</a>, e.g. <code>XNAS</code>"
        },
        {
          "displayName": "Latest",
          "name": "latest",
          "type": "boolean",
          "default": false,
          "description": "Whether to fetch the most recent stock market data"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "description": "Order to sort results in",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASC"
            },
            {
              "name": "Descending",
              "value": "DESC"
            }
          ],
          "default": "DESC"
        },
        {
          "displayName": "Specific Date",
          "name": "specificDate",
          "type": "dateTime",
          "default": "",
          "description": "Date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        },
        {
          "displayName": "Timeframe Start Date",
          "name": "dateFrom",
          "type": "dateTime",
          "default": "",
          "description": "Timeframe start date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        },
        {
          "displayName": "Timeframe End Date",
          "name": "dateTo",
          "type": "dateTime",
          "default": "",
          "description": "Timeframe end date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an exchange"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "exchange"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Exchange",
      "name": "exchange",
      "type": "string",
      "default": "",
      "description": "Stock exchange to retrieve, specified by <a href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">Market Identifier Code</a>, e.g. <code>XNAS</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "exchange"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a ticker"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticker"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticker",
      "name": "symbol",
      "type": "string",
      "default": "",
      "description": "Stock symbol (ticker) to retrieve, e.g. <code>AAPL</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticker"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]


node_type: nodes-base.matrix
package_name: n8n-nodes-base
display_name: Matrix
description: Consume Matrix API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "matrixApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Matrix node documentation
  description: Learn how to use the Matrix node in n8n. Follow technical documentation to integrate Matrix node into your workflows.
  contentType: [integration, reference]
  ---

  # Matrix node

  Use the Matrix node to automate work in Matrix, and integrate Matrix with other applications. n8n has built-in support for a wide range of Matrix features, including getting current user's account information, sending media and messages to a room, and getting room members and messages.

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

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

  ## Operations

  * Account
      * Get current user's account information
  * Event
      * Get single event by ID
  * Media
      * Send media to a chat room
  * Message
      * Send a message to a room
      * Gets all messages from a room
  * Room
      * New chat room with defined settings
      * Invite a user to a room
      * Join a new room
      * Kick a user from a room
      * Leave a room
  * Room Member
      * Get all members

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Account",
          "value": "account"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Media",
          "value": "media"
        },
        {
          "name": "Message",
          "value": "message"
        },
        {
          "name": "Room",
          "value": "room"
        },
        {
          "name": "Room Member",
          "value": "roomMember"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "me",
      "options": [
        {
          "name": "Me",
          "value": "me",
          "description": "Get current user's account information",
          "action": "Get the current user's account information"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get single event by ID",
          "action": "Get an event by ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room ID",
      "name": "roomId",
      "type": "string",
      "default": "",
      "description": "The room related to the event",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "The room related to the event",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Upload",
          "value": "upload",
          "description": "Send media to a chat room",
          "action": "Upload media to a chatroom"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "Room ID to post. 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": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Media Type",
      "name": "mediaType",
      "type": "options",
      "default": "image",
      "description": "Type of file being uploaded",
      "options": [
        {
          "name": "File",
          "value": "file",
          "description": "General file"
        },
        {
          "name": "Image",
          "value": "image",
          "description": "Image media type"
        },
        {
          "name": "Audio",
          "value": "audio",
          "description": "Audio media type"
        },
        {
          "name": "Video",
          "value": "video",
          "description": "Video media type"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "Name of the file being uploaded"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Send a message to a room",
          "action": "Create a message"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many messages from a room",
          "action": "Get many messages"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "The channel to send the message to. 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": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The text to send",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Message Type",
      "name": "messageType",
      "type": "options",
      "default": "m.text",
      "description": "The type of message to send",
      "options": [
        {
          "name": "Emote",
          "value": "m.emote",
          "description": "Perform an action (similar to /me in IRC)"
        },
        {
          "name": "Notice",
          "value": "m.notice",
          "description": "Send a notice"
        },
        {
          "name": "Text",
          "value": "m.text",
          "description": "Send a text message"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Message Format",
      "name": "messageFormat",
      "type": "options",
      "default": "plain",
      "description": "The format of the message's body",
      "options": [
        {
          "name": "Plain Text",
          "value": "plain",
          "description": "Text only"
        },
        {
          "name": "HTML",
          "value": "org.matrix.custom.html",
          "description": "HTML-formatted text"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Fallback Text",
      "name": "fallbackText",
      "type": "string",
      "default": "",
      "description": "A plain text message to display in case the HTML cannot be rendered by the Matrix client",
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "create"
          ],
          "messageFormat": [
            "org.matrix.custom.html"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "The token to start returning events from. This token can be obtained from a prev_batch token returned for each room by the sync API. 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": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Other Options",
      "name": "otherOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filter",
          "name": "filter",
          "type": "string",
          "default": "",
          "description": "A JSON RoomEventFilter to filter returned events with. More information can be found on this <a href=\"https://matrix.org/docs/spec/client_server/r0.6.0\">page</a>.",
          "placeholder": "{\"contains_url\":true,\"types\":[\"m.room.message\", \"m.sticker\"]}"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "New chat room with defined settings",
          "action": "Create a room"
        },
        {
          "name": "Invite",
          "value": "invite",
          "description": "Invite a user to a room",
          "action": "Invite a room"
        },
        {
          "name": "Join",
          "value": "join",
          "description": "Join a new room",
          "action": "Join a room"
        },
        {
          "name": "Kick",
          "value": "kick",
          "description": "Kick a user from a room",
          "action": "Kick a user from a room"
        },
        {
          "name": "Leave",
          "value": "leave",
          "description": "Leave a room",
          "action": "Leave a room"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name",
      "name": "roomName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Preset",
      "name": "preset",
      "type": "options",
      "default": "public_chat",
      "options": [
        {
          "name": "Private Chat",
          "value": "private_chat"
        },
        {
          "name": "Public Chat",
          "value": "public_chat",
          "description": "Open and public chat"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Room Alias",
      "name": "roomAlias",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Room ID or Alias",
      "name": "roomIdOrAlias",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "join"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "leave"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "invite"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The fully qualified user ID of the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "invite"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The fully qualified user ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      }
    },
    {
      "displayName": "Reason",
      "name": "reason",
      "type": "string",
      "default": "",
      "description": "Reason for kick",
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members",
          "action": "Get many room members"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "roomMember"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "roomMember"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "description": "Filtering options",
      "options": [
        {
          "displayName": "Exclude Membership",
          "name": "notMembership",
          "type": "options",
          "default": "",
          "description": "Excludes members whose membership is other than selected (uses OR filter with membership)",
          "options": [
            {
              "name": "Any",
              "value": "",
              "description": "Any user membership"
            },
            {
              "name": "Ban",
              "value": "ban",
              "description": "Users removed from the room"
            },
            {
              "name": "Invite",
              "value": "invite",
              "description": "Users invited to join"
            },
            {
              "name": "Join",
              "value": "join",
              "description": "Users currently in the room"
            },
            {
              "name": "Leave",
              "value": "leave",
              "description": "Users who left"
            }
          ]
        },
        {
          "displayName": "Membership",
          "name": "membership",
          "type": "options",
          "default": "",
          "description": "Only fetch users with selected membership status (uses OR filter with exclude membership)",
          "options": [
            {
              "name": "Any",
              "value": "",
              "description": "Any user membership"
            },
            {
              "name": "Ban",
              "value": "ban",
              "description": "Users removed from the room"
            },
            {
              "name": "Invite",
              "value": "invite",
              "description": "Users invited to join"
            },
            {
              "name": "Join",
              "value": "join",
              "description": "Users currently in the room"
            },
            {
              "name": "Leave",
              "value": "leave",
              "description": "Users who left"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "roomMember"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "me",
      "name": "Me",
      "description": "Get current user's account information"
    }
  ]


node_type: nodes-base.mattermost
package_name: n8n-nodes-base
display_name: Mattermost
description: Sends data to Mattermost
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mattermostApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-09-04 08:34:49
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mattermost node documentation
  description: Learn how to use the Mattermost node in n8n. Follow technical documentation to integrate Mattermost node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Mattermost node

  Use the Mattermost node to automate work in Mattermost, and integrate Mattermost with other applications. n8n has built-in support for a wide range of Mattermost features, including creating, deleting, and getting channels, and users, as well as posting messages, and adding reactions.

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

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

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

  ## Operations

  * Channel
      * Add a user to a channel
      * Create a new channel
      * Soft delete a channel
      * Get a page of members for a channel
      * Restores a soft deleted channel
      * Search for a channel
      * Get statistics for a channel
  * Message
      * Soft delete a post, by marking the post as deleted in the database
      * Post a message into a channel
      * Post an ephemeral message into a channel
  * Reaction
      * Add a reaction to a post.
      * Remove a reaction from a post
      * Get all the reactions to one or more posts
  * User
      * Create a new user
      * Deactivates the user and revokes all its sessions by archiving its user object.
      * Retrieve all users
      * Get a user by email
      * Get a user by ID
      * Invite user to team


  ## Templates and examples

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

  ## Related resources

  Refer to [Mattermost's documentation](https://api.mattermost.com/){:target=_blank .external-link} for more information about the service.

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

  ## Channel ID field error

  If you're not the System Administrator, you might get an error: **there was a problem loading the parameter options from server: "Mattermost error response: You do not have the appropriate permissions.** next to the **Channel ID** field.

  Ask your system administrator to grant you the `post:channel` permission.

  ## Find the channel ID

  To find the channel ID in Mattermost:

  1. Select the channel from the left sidebar.
  2. Select the channel name at the top.
  3. Select **View Info**.

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Channel",
          "value": "channel"
        },
        {
          "name": "Message",
          "value": "message"
        },
        {
          "name": "Reaction",
          "value": "reaction"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add User",
          "value": "addUser",
          "description": "Add a user to a channel",
          "action": "Add a user to a channel"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new channel",
          "action": "Create a channel"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Soft delete a channel",
          "action": "Delete a channel"
        },
        {
          "name": "Member",
          "value": "members",
          "description": "Get a page of members for a channel",
          "action": "Get a page of members for a channel"
        },
        {
          "name": "Restore",
          "value": "restore",
          "description": "Restores a soft deleted channel",
          "action": "Restore a soft-deleted channel"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search for a channel",
          "action": "Search for a channel"
        },
        {
          "name": "Statistics",
          "value": "statistics",
          "description": "Get statistics for a channel",
          "action": "Get statistics for a channel"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Display Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "The non-unique UI name for the channel",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "channel",
      "type": "string",
      "default": "",
      "description": "The unique handle for the channel, will be present in the channel URL",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "public",
      "description": "The type of channel to create",
      "options": [
        {
          "name": "Private",
          "value": "private"
        },
        {
          "name": "Public",
          "value": "public"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to soft delete. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannelsInTeam",
        "loadOptionsDependsOn": [
          "teamId"
        ]
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response only contain the ID of the user. If this option gets activated, it will resolve the user automatically.",
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "members"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Channel ID",
      "name": "channelId",
      "type": "string",
      "default": "",
      "description": "The ID of the channel to restore",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "restore"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to invite user to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "addUser"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "The ID of the user to invite into channel. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "addUser"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to get the statistics from. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "statistics"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Search Term",
      "name": "term",
      "type": "string",
      "default": "",
      "description": "The search term for Channels in a Team",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Soft delete a post, by marking the post as deleted in the database",
          "action": "Delete a message"
        },
        {
          "name": "Post",
          "value": "post",
          "description": "Post a message into a channel",
          "action": "Post a message"
        },
        {
          "name": "Post Ephemeral",
          "value": "postEphemeral",
          "description": "Post an ephemeral message into a channel",
          "action": "Post an ephemeral message"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to post to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The text to send",
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "collection",
      "default": {},
      "description": "The attachment to add",
      "options": [
        {
          "displayName": "Actions",
          "name": "actions",
          "placeholder": "Add Actions",
          "description": "Actions to add to message. More information can be found <a href=\"https://docs.mattermost.com/developer/interactive-messages.html\" target=\"_blank\">here</a>.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item",
              "name": "item",
              "values": [
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Button",
                      "value": "button"
                    },
                    {
                      "name": "Select",
                      "value": "select"
                    }
                  ],
                  "default": "button",
                  "description": "The type of the action"
                },
                {
                  "displayName": "Data Source",
                  "name": "data_source",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "type": [
                        "select"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Channels",
                      "value": "channels"
                    },
                    {
                      "name": "Custom",
                      "value": "custom"
                    },
                    {
                      "name": "Users",
                      "value": "users"
                    }
                  ],
                  "default": "custom",
                  "description": "The type of the action"
                },
                {
                  "displayName": "Options",
                  "name": "options",
                  "placeholder": "Add option",
                  "description": "Adds a new option to select field",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": true
                  },
                  "displayOptions": {
                    "show": {
                      "data_source": [
                        "custom"
                      ],
                      "type": [
                        "select"
                      ]
                    }
                  },
                  "default": {},
                  "options": [
                    {
                      "name": "option",
                      "displayName": "Option",
                      "default": {},
                      "values": [
                        {
                          "displayName": "Option Text",
                          "name": "text",
                          "type": "string",
                          "default": "",
                          "description": "Text of the option"
                        },
                        {
                          "displayName": "Option Value",
                          "name": "value",
                          "type": "string",
                          "default": "",
                          "description": "Value of the option"
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the Action"
                },
                {
                  "displayName": "Integration",
                  "name": "integration",
                  "placeholder": "Add Integration",
                  "description": "Integration to add to message",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": false
                  },
                  "default": {},
                  "options": [
                    {
                      "displayName": "Item",
                      "name": "item",
                      "default": {},
                      "values": [
                        {
                          "displayName": "URL",
                          "name": "url",
                          "type": "string",
                          "default": "",
                          "description": "URL of the Integration"
                        },
                        {
                          "displayName": "Context",
                          "name": "context",
                          "placeholder": "Add Context to Integration",
                          "description": "Adds a Context values set",
                          "type": "fixedCollection",
                          "typeOptions": {
                            "multipleValues": true
                          },
                          "default": {},
                          "options": [
                            {
                              "name": "property",
                              "displayName": "Property",
                              "default": {},
                              "values": [
                                {
                                  "displayName": "Property Name",
                                  "name": "name",
                                  "type": "string",
                                  "default": "",
                                  "description": "Name of the property to set"
                                },
                                {
                                  "displayName": "Property Value",
                                  "name": "value",
                                  "type": "string",
                                  "default": "",
                                  "description": "Value of the property to set"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "displayName": "Author Icon",
          "name": "author_icon",
          "type": "string",
          "default": "",
          "description": "Icon which should appear for the user"
        },
        {
          "displayName": "Author Link",
          "name": "author_link",
          "type": "string",
          "default": "",
          "description": "Link for the author"
        },
        {
          "displayName": "Author Name",
          "name": "author_name",
          "type": "string",
          "default": "",
          "description": "Name that should appear"
        },
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "#ff0000",
          "description": "Color of the line left of text"
        },
        {
          "displayName": "Fallback Text",
          "name": "fallback",
          "type": "string",
          "default": "",
          "description": "Required plain-text summary of the attachment"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "placeholder": "Add Fields",
          "description": "Fields to add to message",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "item",
              "displayName": "Item",
              "values": [
                {
                  "displayName": "Title",
                  "name": "title",
                  "type": "string",
                  "default": "",
                  "description": "Title of the item"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the item"
                },
                {
                  "displayName": "Short",
                  "name": "short",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether items can be displayed next to each other"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Footer",
          "name": "footer",
          "type": "string",
          "default": "",
          "description": "Text of footer to add"
        },
        {
          "displayName": "Footer Icon",
          "name": "footer_icon",
          "type": "string",
          "default": "",
          "description": "Icon which should appear next to footer"
        },
        {
          "displayName": "Image URL",
          "name": "image_url",
          "type": "string",
          "default": "",
          "description": "URL of image"
        },
        {
          "displayName": "Pretext",
          "name": "pretext",
          "type": "string",
          "default": "",
          "description": "Text which appears before the message block"
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "description": "Text to send"
        },
        {
          "displayName": "Thumbnail URL",
          "name": "thumb_url",
          "type": "string",
          "default": "",
          "description": "URL of thumbnail"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the message"
        },
        {
          "displayName": "Title Link",
          "name": "title_link",
          "type": "string",
          "default": "",
          "description": "Link of the title"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add attachment"
      }
    },
    {
      "displayName": "Other Options",
      "name": "otherOptions",
      "type": "collection",
      "default": {},
      "description": "Other options to set",
      "options": [
        {
          "displayName": "Make Comment",
          "name": "root_id",
          "type": "string",
          "default": "",
          "description": "The post ID to comment on"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "ID of the user to send the ephemeral message to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "postEphemeral"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "ID of the channel to send the ephemeral message in. 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": [
            "postEphemeral"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Text to send in the ephemeral message",
      "displayOptions": {
        "show": {
          "operation": [
            "postEphemeral"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Add a reaction to a post",
          "action": "Create a reaction"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Remove a reaction from a post",
          "action": "Delete a reaction"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many reactions to one or more posts",
          "action": "Get many reactions"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "ID of the user sending the reaction. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to react to. Obtainable from the post link: <code>https://mattermost.internal.n8n.io/[server]/pl/[postId]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Emoji Name",
      "name": "emojiName",
      "type": "string",
      "default": "",
      "description": "Emoji to use for this reaction",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "ID of the user whose reaction to delete. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post whose reaction to delete. Obtainable from the post link: <code>https://mattermost.internal.n8n.io/[server]/pl/[postId]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Emoji Name",
      "name": "emojiName",
      "type": "string",
      "default": "",
      "description": "Name of the emoji to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "One or more (comma-separated) posts to retrieve reactions from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "reaction"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "reaction"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "action": "Create a user"
        },
        {
          "name": "Deactive",
          "value": "deactive",
          "description": "Deactivates the user and revokes all its sessions by archiving its user object",
          "action": "Deactivate a user"
        },
        {
          "name": "Get By Email",
          "value": "getByEmail",
          "description": "Get a user by email",
          "action": "Get a user by email"
        },
        {
          "name": "Get By ID",
          "value": "getById",
          "description": "Get a user by ID",
          "action": "Get a user by ID"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many users",
          "action": "Get many users"
        },
        {
          "name": "Invite",
          "value": "invite",
          "description": "Invite user to team",
          "action": "Invite a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Auth Service",
      "name": "authService",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Gitlab",
          "value": "gitlab"
        },
        {
          "name": "Google",
          "value": "google"
        },
        {
          "name": "LDAP",
          "value": "ldap"
        },
        {
          "name": "Office365",
          "value": "office365"
        },
        {
          "name": "SAML",
          "value": "saml"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Auth Data",
      "name": "authData",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        },
        "hide": {
          "authService": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ],
          "authService": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "description": "The password used for email authentication",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ],
          "authService": [
            "email"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Locale",
          "name": "locale",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Nickname",
          "name": "nickname",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notification Settings",
          "name": "notificationUi",
          "type": "fixedCollection",
          "placeholder": "Add Notification Setting",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Notify",
              "name": "notificationValues",
              "values": [
                {
                  "displayName": "Channel",
                  "name": "channel",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether to enable channel-wide notifications (@channel, @all, etc.), \"false\" to disable. Defaults to \"true\"."
                },
                {
                  "displayName": "Desktop",
                  "name": "desktop",
                  "type": "options",
                  "options": [
                    {
                      "name": "All",
                      "value": "all",
                      "description": "Notifications for all activity"
                    },
                    {
                      "name": "Mention",
                      "value": "mention",
                      "description": "Mentions and direct messages only"
                    },
                    {
                      "name": "None",
                      "value": "none",
                      "description": "Mentions and direct messages only"
                    }
                  ],
                  "default": "all"
                },
                {
                  "displayName": "Desktop Sound",
                  "name": "desktop_sound",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether to enable sound on desktop notifications, \"false\" to disable. Defaults to \"true\"."
                },
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to enable email notifications, \"false\" to disable. Defaults to \"false\"."
                },
                {
                  "displayName": "First Name",
                  "name": "first_name",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to enable mentions for first name. Defaults to \"true\" if a first name is set, \"false\" otherwise."
                },
                {
                  "displayName": "Mention Keys",
                  "name": "mention_keys",
                  "type": "string",
                  "default": "",
                  "description": "A comma-separated list of words to count as mentions. Defaults to username and @username."
                },
                {
                  "displayName": "Push",
                  "name": "push",
                  "type": "options",
                  "options": [
                    {
                      "name": "All",
                      "value": "all",
                      "description": "Notifications for all activity"
                    },
                    {
                      "name": "Mention",
                      "value": "mention",
                      "description": "Mentions and direct messages only"
                    },
                    {
                      "name": "None",
                      "value": "none",
                      "description": "Mentions and direct messages only"
                    }
                  ],
                  "default": "mention"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "User GUID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "deactive"
          ]
        }
      }
    },
    {
      "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": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "In Channel",
          "name": "inChannel",
          "type": "string",
          "default": "",
          "description": "The ID of the channel to get users for"
        },
        {
          "displayName": "In Team",
          "name": "inTeam",
          "type": "string",
          "default": "",
          "description": "The ID of the team to get users for"
        },
        {
          "displayName": "Not In Team",
          "name": "notInTeam",
          "type": "string",
          "default": "",
          "description": "The ID of the team to exclude users for"
        },
        {
          "displayName": "Not In Channel",
          "name": "notInChannel",
          "type": "string",
          "default": "",
          "description": "The ID of the channel to exclude users for"
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "options",
          "options": [
            {
              "name": "Created At",
              "value": "createdAt"
            },
            {
              "name": "Last Activity At",
              "value": "lastActivityAt"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Username",
              "value": "username"
            }
          ],
          "default": "username",
          "description": "The ID of the channel to exclude users for"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "User's email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getByEmail"
          ]
        }
      }
    },
    {
      "displayName": "User IDs",
      "name": "userIds",
      "type": "string",
      "default": "",
      "description": "User's ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getById"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Since",
          "name": "since",
          "type": "dateTime",
          "default": "",
          "description": "Only return users that have been modified since the given Unix timestamp (in milliseconds)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getById"
          ]
        }
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "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": [
            "user"
          ],
          "operation": [
            "invite"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Emails",
      "name": "emails",
      "type": "string",
      "default": "",
      "description": "User's email. Multiple emails can be set separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "invite"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "addUser",
      "name": "Add User",
      "description": "Add a user to a channel"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new channel"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Soft delete a channel"
    },
    {
      "operation": "members",
      "name": "Member",
      "description": "Get a page of members for a channel"
    },
    {
      "operation": "restore",
      "name": "Restore",
      "description": "Restores a soft deleted channel"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search for a channel"
    },
    {
      "operation": "statistics",
      "name": "Statistics",
      "description": "Get statistics for a channel"
    }
  ]


