# nodes

node_type: nodes-base.dropcontactTool
package_name: n8n-nodes-base
display_name: Dropcontact Tool
description: Find B2B emails and enrich contacts (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "dropcontactApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.dropcontact
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Dropcontact node documentation
  description: Learn how to use the Dropcontact node in n8n. Follow technical documentation to integrate Dropcontact node into your workflows.
  contentType: [integration, reference]
  ---

  # Dropcontact node

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

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

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

  ## Operations

  **Contact**
  - Enrich
  - Fetch Request

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Dropcontact"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "enrich",
      "options": [
        {
          "name": "Enrich",
          "value": "enrich",
          "description": "Find B2B emails and enrich your contact from his name and his website",
          "action": "Find B2B emails"
        },
        {
          "name": "Fetch Request",
          "value": "fetchRequest"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Request ID",
      "name": "requestId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "fetchRequest"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    },
    {
      "displayName": "Simplify Output (Faster)",
      "name": "simplify",
      "type": "boolean",
      "default": false,
      "description": "When off, waits for the contact data before completing. Waiting time can be adjusted with Extend Wait Time option. When on, returns a request_id that can be used later in the Fetch Request operation.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company SIREN Number",
          "name": "num_siren",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company SIRET Code",
          "name": "siret",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Name",
          "name": "company",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Full Name",
          "name": "full_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Profile",
          "name": "linkedin",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone Number",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Data Fetch Wait Time",
          "name": "waitTime",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "displayOptions": {
            "show": {
              "/simplify": [
                false
              ]
            }
          },
          "default": 45,
          "description": "When not simplifying the response, data will be fetched in two steps. This parameter controls how long to wait (in seconds) before trying the second step."
        },
        {
          "displayName": "French Company Enrich",
          "name": "siren",
          "type": "boolean",
          "default": false,
          "description": "Whether you want the <a href=\"https://en.wikipedia.org/wiki/SIREN_code\" target=\"_blank\">SIREN number</a>, NAF code, TVA number, company address and informations about the company leader. Only applies to french companies."
        },
        {
          "displayName": "Language",
          "name": "language",
          "type": "options",
          "options": [
            {
              "name": "English",
              "value": "en"
            },
            {
              "name": "French",
              "value": "fr"
            }
          ],
          "default": "en",
          "description": "Whether the response is in English or French"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "enrich",
      "name": "Enrich",
      "description": "Find B2B emails and enrich your contact from his name and his website"
    },
    {
      "operation": "fetchRequest",
      "name": "Fetch Request"
    }
  ]


node_type: nodes-base.dropcontact
package_name: n8n-nodes-base
display_name: Dropcontact
description: Find B2B emails and enrich contacts
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "dropcontactApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Dropcontact node documentation
  description: Learn how to use the Dropcontact node in n8n. Follow technical documentation to integrate Dropcontact node into your workflows.
  contentType: [integration, reference]
  ---

  # Dropcontact node

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

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

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

  ## Operations

  **Contact**
  - Enrich
  - Fetch Request

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "enrich",
      "options": [
        {
          "name": "Enrich",
          "value": "enrich",
          "description": "Find B2B emails and enrich your contact from his name and his website",
          "action": "Find B2B emails"
        },
        {
          "name": "Fetch Request",
          "value": "fetchRequest"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Request ID",
      "name": "requestId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "fetchRequest"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    },
    {
      "displayName": "Simplify Output (Faster)",
      "name": "simplify",
      "type": "boolean",
      "default": false,
      "description": "When off, waits for the contact data before completing. Waiting time can be adjusted with Extend Wait Time option. When on, returns a request_id that can be used later in the Fetch Request operation.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company SIREN Number",
          "name": "num_siren",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company SIRET Code",
          "name": "siret",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Name",
          "name": "company",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Full Name",
          "name": "full_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Profile",
          "name": "linkedin",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone Number",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Data Fetch Wait Time",
          "name": "waitTime",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "displayOptions": {
            "show": {
              "/simplify": [
                false
              ]
            }
          },
          "default": 45,
          "description": "When not simplifying the response, data will be fetched in two steps. This parameter controls how long to wait (in seconds) before trying the second step."
        },
        {
          "displayName": "French Company Enrich",
          "name": "siren",
          "type": "boolean",
          "default": false,
          "description": "Whether you want the <a href=\"https://en.wikipedia.org/wiki/SIREN_code\" target=\"_blank\">SIREN number</a>, NAF code, TVA number, company address and informations about the company leader. Only applies to french companies."
        },
        {
          "displayName": "Language",
          "name": "language",
          "type": "options",
          "options": [
            {
              "name": "English",
              "value": "en"
            },
            {
              "name": "French",
              "value": "fr"
            }
          ],
          "default": "en",
          "description": "Whether the response is in English or French"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "enrich"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "enrich",
      "name": "Enrich",
      "description": "Find B2B emails and enrich your contact from his name and his website"
    },
    {
      "operation": "fetchRequest",
      "name": "Fetch Request"
    }
  ]


node_type: nodes-base.editImage
package_name: n8n-nodes-base
display_name: Edit Image
description: Edits an image like blur, resize or adding border and text
category: transform
development_style: programmatic
version: 1
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Edit Image
  description: Documentation for the Edit Image node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Edit Image

  Use the Edit Image node to manipulate and edit images.

  /// note | Dependencies
  1. If you aren't running n8n on Docker, you need to install [GraphicsMagick](http://www.graphicsmagick.org/README.html){:target=_blank .external-link}.
  2. You need to use a node such as the [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) node or the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node to pass the image file as a data property to the Edit Image node.
  ///

  ## Operations

  - Add a **Blur** to the image to reduce sharpness
  - Add a **Border** to the image
  - **Composite** an image on top of another image
  - **Create** a new image
  - **Crop** the image
  - **Draw** on an image
  - **Get Information** about the image
  - **Multi Step** perform multiple operations on the image
  - **Resize**: Change the size of the image
  - **Rotate** the image
  - **Shear** image along the X or Y axis
  - Add **Text** to the image
  - Make a color in image **Transparent**

  ## Node parameters

  The parameters for this node depend on the operation you select.

  ### Blur parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Blur**: Enter a number to set how strong the blur should be, between 0 and 1000. Higher numbers create blurrier images.
  * **Sigma**: Enter a number to set the stigma for the blur, between 0 and 1000. Higher numbers create blurrier images.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Border parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Border Width**: Enter the width of the border.
  * **Border Height**: Enter the height of the border.
  * **Border Color**: Set the color for the border. You can either enter a hex or select the color swatch to open a color picker.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Composite parameters

  * **Property Name**: Enter the name of the binary property that stores the image data. This image is your base image.
  * **Composite Image Property**: Enter the name of the binary property that stores image to composite on top of the **Property Name** image.
  * **Operator**: Select composite operator, which determines how the composite works. Options include:
  	* **Add**
  	* **Atop**
  	* **Bumpmap**
  	* **Copy**
  	* **Copy Black**
  	* **Copy Blue**
  	* **Copy Cyan**
  	* **Copy Green**
  	* **Copy Magenta**
  	* **Copy Opacity**
  	* **Copy Red**
  	* **Copy Yellow**
  	* **Difference**
  	* **Divide**
  	* **In**
  	* **Minus**
  	* **Multiply**
  	* **Out**
  	* **Over**
  	* **Plus**
  	* **Subtract**
  	* **Xor**
  * **Position X**: Enter the x axis position (horizontal) of the composite image.
  * **Position Y**: Enter the y axis position (vertical) of the composite image.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Create parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Background Color**: Set the background color for the image. You can either enter a hex or select the color swatch to open a color picker.
  * **Image Width**: Enter the width of the image.
  * **Image Height**: Enter the height of the image.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Crop parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Width**: Enter the width you'd like to crop to.
  * **Height**: Enter the height you'd like to crop to.
  * **Position X**: Enter the x axis position (horizontal) to start the crop from.
  * **Position Y**: Enter the y axis position (vertical) to start the crop from.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Draw parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Primitive**: Select the primitive shape to draw. Choose from:
  	* **Circle**
  	* **Line**
  	* **Rectangle**
  * **Color**: Set the color for the primitive. You can either enter a hex or select the color swatch to open a color picker.
  * **Start Position X**: Enter the x axis position (horizontal) to start drawing from.
  * **Start Position Y**: Enter the y axis position (vertical) to start drawing from.
  * **End Position X**: Enter the x axis position (horizontal) to stop drawing at.
  * **End Position Y**: Enter the y axis position (vertical) to start drawing at.
  * **Corner Radius**: Enter a number to set the corner radius. Adding a corner radius will round the corners of the drawn primitive.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Get Information parameters

  For this operation, you only need to add the **Property Name** of the binary property that stores the image data.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Multi Step parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Operations**: Add the operations you want the multi step operation to perform. You can use any of the other operations.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Resize parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Width**: Enter the new width you'd like for the image.
  * **Height**: Enter the new height you'd like for the image.
  * **Option**: Select how you'd like to resize the image. Choose from:
  	* **Ignore Aspect Ratio**: Ignore the aspect ratio and resize to the exact height and width you've entered.
  	* **Maximum Area**: The height and width you've entered is the maximum area/size for the image. The image maintains its aspect ratio and won't be larger than the height and/or width you've entered.
  	* **Minimum Area**: The height and width you've entered is the minimum area/size for the image. The image maintains its aspect ratio and won't be smaller than the height and/or width you've entered.
  	* **Only if Larger**: Resize the image only if it's larger than the width and height you entered. The image maintains its aspect ratio.
  	* **Only if Smaller**: Resize the image only if it's smaller than the width and height you entered. The image maintains its aspect ratio.
  	* **Percent**: Resize the image using the width and height as percentages of the original image.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Rotate parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Rotate**: Enter the number of degrees to rotate the image, from --360 to 360.
  * **Background Color**: Set the background color for the image. You can either enter a hex or select the color swatch to open a color picker. This color is used to fill in the empty background whenever the image is rotated by multiples of 90 degrees. If multipled of 90 degrees are used for the **Rotate** field, the background color isn't used.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Shear parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Degrees X**: Enter the number of degrees to shear from the x axis.
  * **Degrees Y**: Enter the number of degrees to shear from the y axis.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Text parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Text**: Enter the text you'd like to write on the image.
  * **Font Size**: Select the font size for the text.
  * **Font Color**: Set the font color. You can either enter a hex or select the color swatch to open a color picker.
  * **Position X**: Enter the x axis position (horizontal) to begin the text at.
  * **Position Y**: Enter the y axis position (vertical) to begin the text at.
  * **Max Line Length**: Enter the maximum amount of characters in a line before adding a line break.

  Refer to [Node options](#node-options) for optional configuration options.

  ### Transparent parameters

  * **Property Name**: Enter the name of the binary property that stores the image data.
  * **Color**: Set the color to make transparent. You can either enter a hex or select the color swatch to open a color picker.

  Refer to [Node options](#node-options) for optional configuration options.

  ## Node options

  - **File Name**: Enter the filename of the output file.
  - **Format**: Enter the image format of the output file. Choose from:
  	- **bmp**
  	- **gif**
  	- **jpeg**
  	- **png**
  	- **tiff**
  	- **WebP**

  The **Text** operation also includes the option for **Font Name or ID**. Select the text font from the dropdown or specify an ID using an [expression](/code/expressions.md).

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "border",
      "options": [
        {
          "name": "Blur",
          "value": "blur",
          "description": "Adds a blur to the image and so makes it less sharp",
          "action": "Blur Image"
        },
        {
          "name": "Border",
          "value": "border",
          "description": "Adds a border to the image",
          "action": "Border Image"
        },
        {
          "name": "Composite",
          "value": "composite",
          "description": "Composite image on top of another one",
          "action": "Composite Image"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new image",
          "action": "Create Image"
        },
        {
          "name": "Crop",
          "value": "crop",
          "description": "Crops the image",
          "action": "Crop Image"
        },
        {
          "name": "Draw",
          "value": "draw",
          "description": "Draw on image",
          "action": "Draw Image"
        },
        {
          "name": "Get Information",
          "value": "information",
          "description": "Returns image information like resolution"
        },
        {
          "name": "Multi Step",
          "value": "multiStep",
          "description": "Perform multiple operations"
        },
        {
          "name": "Resize",
          "value": "resize",
          "description": "Change the size of image",
          "action": "Resize Image"
        },
        {
          "name": "Rotate",
          "value": "rotate",
          "description": "Rotate image",
          "action": "Rotate Image"
        },
        {
          "name": "Shear",
          "value": "shear",
          "description": "Shear image along the X or Y axis",
          "action": "Shear Image"
        },
        {
          "name": "Text",
          "value": "text",
          "description": "Adds text to image",
          "action": "Apply Text to Image"
        },
        {
          "name": "Transparent",
          "value": "transparent",
          "description": "Make a color in image transparent",
          "action": "Add Transparency to Image"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property in which the image data can be found"
    },
    {
      "displayName": "Operations",
      "name": "operations",
      "type": "fixedCollection",
      "default": {},
      "description": "The operations to perform",
      "options": [
        {
          "name": "operations",
          "displayName": "Operations",
          "values": [
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Blur",
                  "value": "blur",
                  "description": "Adds a blur to the image and so makes it less sharp",
                  "action": "Blur Image"
                },
                {
                  "name": "Border",
                  "value": "border",
                  "description": "Adds a border to the image",
                  "action": "Border Image"
                },
                {
                  "name": "Composite",
                  "value": "composite",
                  "description": "Composite image on top of another one",
                  "action": "Composite Image"
                },
                {
                  "name": "Create",
                  "value": "create",
                  "description": "Create a new image",
                  "action": "Create Image"
                },
                {
                  "name": "Crop",
                  "value": "crop",
                  "description": "Crops the image",
                  "action": "Crop Image"
                },
                {
                  "name": "Draw",
                  "value": "draw",
                  "description": "Draw on image",
                  "action": "Draw Image"
                },
                {
                  "name": "Rotate",
                  "value": "rotate",
                  "description": "Rotate image",
                  "action": "Rotate Image"
                },
                {
                  "name": "Resize",
                  "value": "resize",
                  "description": "Change the size of image",
                  "action": "Resize Image"
                },
                {
                  "name": "Shear",
                  "value": "shear",
                  "description": "Shear image along the X or Y axis",
                  "action": "Shear Image"
                },
                {
                  "name": "Text",
                  "value": "text",
                  "description": "Adds text to image",
                  "action": "Apply Text to Image"
                },
                {
                  "name": "Transparent",
                  "value": "transparent",
                  "description": "Make a color in image transparent",
                  "action": "Add Transparency to Image"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Background Color",
              "name": "backgroundColor",
              "type": "color",
              "default": "#ffffff00",
              "typeOptions": {
                "showAlpha": true
              },
              "displayOptions": {
                "show": {
                  "operation": [
                    "create"
                  ]
                }
              },
              "description": "The background color of the image to create"
            },
            {
              "displayName": "Image Width",
              "name": "width",
              "type": "number",
              "default": 50,
              "typeOptions": {
                "minValue": 1
              },
              "displayOptions": {
                "show": {
                  "operation": [
                    "create"
                  ]
                }
              },
              "description": "The width of the image to create"
            },
            {
              "displayName": "Image Height",
              "name": "height",
              "type": "number",
              "default": 50,
              "typeOptions": {
                "minValue": 1
              },
              "displayOptions": {
                "show": {
                  "operation": [
                    "create"
                  ]
                }
              },
              "description": "The height of the image to create"
            },
            {
              "displayName": "Primitive",
              "name": "primitive",
              "type": "options",
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ]
                }
              },
              "options": [
                {
                  "name": "Circle",
                  "value": "circle"
                },
                {
                  "name": "Line",
                  "value": "line"
                },
                {
                  "name": "Rectangle",
                  "value": "rectangle"
                }
              ],
              "default": "rectangle",
              "description": "The primitive to draw"
            },
            {
              "displayName": "Color",
              "name": "color",
              "type": "color",
              "default": "#ff000000",
              "typeOptions": {
                "showAlpha": true
              },
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ]
                }
              },
              "description": "The color of the primitive to draw"
            },
            {
              "displayName": "Start Position X",
              "name": "startPositionX",
              "type": "number",
              "default": 50,
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ],
                  "primitive": [
                    "circle",
                    "line",
                    "rectangle"
                  ]
                }
              },
              "description": "X (horizontal) start position of the primitive"
            },
            {
              "displayName": "Start Position Y",
              "name": "startPositionY",
              "type": "number",
              "default": 50,
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ],
                  "primitive": [
                    "circle",
                    "line",
                    "rectangle"
                  ]
                }
              },
              "description": "Y (horizontal) start position of the primitive"
            },
            {
              "displayName": "End Position X",
              "name": "endPositionX",
              "type": "number",
              "default": 250,
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ],
                  "primitive": [
                    "circle",
                    "line",
                    "rectangle"
                  ]
                }
              },
              "description": "X (horizontal) end position of the primitive"
            },
            {
              "displayName": "End Position Y",
              "name": "endPositionY",
              "type": "number",
              "default": 250,
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ],
                  "primitive": [
                    "circle",
                    "line",
                    "rectangle"
                  ]
                }
              },
              "description": "Y (horizontal) end position of the primitive"
            },
            {
              "displayName": "Corner Radius",
              "name": "cornerRadius",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "draw"
                  ],
                  "primitive": [
                    "rectangle"
                  ]
                }
              },
              "description": "The radius of the corner to create round corners"
            },
            {
              "displayName": "Text",
              "name": "text",
              "typeOptions": {
                "rows": 5
              },
              "type": "string",
              "default": "",
              "placeholder": "Text to render",
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "description": "Text to write on the image"
            },
            {
              "displayName": "Font Size",
              "name": "fontSize",
              "type": "number",
              "default": 18,
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "description": "Size of the text"
            },
            {
              "displayName": "Font Color",
              "name": "fontColor",
              "type": "color",
              "default": "#000000",
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "description": "Color of the text"
            },
            {
              "displayName": "Position X",
              "name": "positionX",
              "type": "number",
              "default": 50,
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "description": "X (horizontal) position of the text"
            },
            {
              "displayName": "Position Y",
              "name": "positionY",
              "type": "number",
              "default": 50,
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "description": "Y (vertical) position of the text"
            },
            {
              "displayName": "Max Line Length",
              "name": "lineLength",
              "type": "number",
              "typeOptions": {
                "minValue": 1
              },
              "default": 80,
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "description": "Max amount of characters in a line before a line-break should get added"
            },
            {
              "displayName": "Blur",
              "name": "blur",
              "type": "number",
              "typeOptions": {
                "minValue": 0,
                "maxValue": 1000
              },
              "default": 5,
              "displayOptions": {
                "show": {
                  "operation": [
                    "blur"
                  ]
                }
              },
              "description": "How strong the blur should be"
            },
            {
              "displayName": "Sigma",
              "name": "sigma",
              "type": "number",
              "typeOptions": {
                "minValue": 0,
                "maxValue": 1000
              },
              "default": 2,
              "displayOptions": {
                "show": {
                  "operation": [
                    "blur"
                  ]
                }
              },
              "description": "The sigma of the blur"
            },
            {
              "displayName": "Border Width",
              "name": "borderWidth",
              "type": "number",
              "default": 10,
              "displayOptions": {
                "show": {
                  "operation": [
                    "border"
                  ]
                }
              },
              "description": "The width of the border"
            },
            {
              "displayName": "Border Height",
              "name": "borderHeight",
              "type": "number",
              "default": 10,
              "displayOptions": {
                "show": {
                  "operation": [
                    "border"
                  ]
                }
              },
              "description": "The height of the border"
            },
            {
              "displayName": "Border Color",
              "name": "borderColor",
              "type": "color",
              "default": "#000000",
              "displayOptions": {
                "show": {
                  "operation": [
                    "border"
                  ]
                }
              },
              "description": "Color of the border"
            },
            {
              "displayName": "Composite Image Property",
              "name": "dataPropertyNameComposite",
              "type": "string",
              "default": "",
              "placeholder": "data2",
              "displayOptions": {
                "show": {
                  "operation": [
                    "composite"
                  ]
                }
              },
              "description": "The name of the binary property which contains the data of the image to composite on top of image which is found in Property Name"
            },
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "displayOptions": {
                "show": {
                  "operation": [
                    "composite"
                  ]
                }
              },
              "options": [
                {
                  "name": "Add",
                  "value": "Add"
                },
                {
                  "name": "Atop",
                  "value": "Atop"
                },
                {
                  "name": "Bumpmap",
                  "value": "Bumpmap"
                },
                {
                  "name": "Copy",
                  "value": "Copy"
                },
                {
                  "name": "Copy Black",
                  "value": "CopyBlack"
                },
                {
                  "name": "Copy Blue",
                  "value": "CopyBlue"
                },
                {
                  "name": "Copy Cyan",
                  "value": "CopyCyan"
                },
                {
                  "name": "Copy Green",
                  "value": "CopyGreen"
                },
                {
                  "name": "Copy Magenta",
                  "value": "CopyMagenta"
                },
                {
                  "name": "Copy Opacity",
                  "value": "CopyOpacity"
                },
                {
                  "name": "Copy Red",
                  "value": "CopyRed"
                },
                {
                  "name": "Copy Yellow",
                  "value": "CopyYellow"
                },
                {
                  "name": "Difference",
                  "value": "Difference"
                },
                {
                  "name": "Divide",
                  "value": "Divide"
                },
                {
                  "name": "In",
                  "value": "In"
                },
                {
                  "name": "Minus",
                  "value": "Minus"
                },
                {
                  "name": "Multiply",
                  "value": "Multiply"
                },
                {
                  "name": "Out",
                  "value": "Out"
                },
                {
                  "name": "Over",
                  "value": "Over"
                },
                {
                  "name": "Plus",
                  "value": "Plus"
                },
                {
                  "name": "Subtract",
                  "value": "Subtract"
                },
                {
                  "name": "Xor",
                  "value": "Xor"
                }
              ],
              "default": "Over",
              "description": "The operator to use to combine the images"
            },
            {
              "displayName": "Position X",
              "name": "positionX",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "composite"
                  ]
                }
              },
              "description": "X (horizontal) position of composite image"
            },
            {
              "displayName": "Position Y",
              "name": "positionY",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "composite"
                  ]
                }
              },
              "description": "Y (vertical) position of composite image"
            },
            {
              "displayName": "Width",
              "name": "width",
              "type": "number",
              "default": 500,
              "displayOptions": {
                "show": {
                  "operation": [
                    "crop"
                  ]
                }
              },
              "description": "Crop width"
            },
            {
              "displayName": "Height",
              "name": "height",
              "type": "number",
              "default": 500,
              "displayOptions": {
                "show": {
                  "operation": [
                    "crop"
                  ]
                }
              },
              "description": "Crop height"
            },
            {
              "displayName": "Position X",
              "name": "positionX",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "crop"
                  ]
                }
              },
              "description": "X (horizontal) position to crop from"
            },
            {
              "displayName": "Position Y",
              "name": "positionY",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "crop"
                  ]
                }
              },
              "description": "Y (vertical) position to crop from"
            },
            {
              "displayName": "Width",
              "name": "width",
              "type": "number",
              "default": 500,
              "displayOptions": {
                "show": {
                  "operation": [
                    "resize"
                  ]
                }
              },
              "description": "New width of the image"
            },
            {
              "displayName": "Height",
              "name": "height",
              "type": "number",
              "default": 500,
              "displayOptions": {
                "show": {
                  "operation": [
                    "resize"
                  ]
                }
              },
              "description": "New height of the image"
            },
            {
              "displayName": "Option",
              "name": "resizeOption",
              "type": "options",
              "options": [
                {
                  "name": "Ignore Aspect Ratio",
                  "value": "ignoreAspectRatio",
                  "description": "Ignore aspect ratio and resize exactly to specified values"
                },
                {
                  "name": "Maximum Area",
                  "value": "maximumArea",
                  "description": "Specified values are maximum area"
                },
                {
                  "name": "Minimum Area",
                  "value": "minimumArea",
                  "description": "Specified values are minimum area"
                },
                {
                  "name": "Only if Larger",
                  "value": "onlyIfLarger",
                  "description": "Resize only if image is larger than width or height"
                },
                {
                  "name": "Only if Smaller",
                  "value": "onlyIfSmaller",
                  "description": "Resize only if image is smaller than width or height"
                },
                {
                  "name": "Percent",
                  "value": "percent",
                  "description": "Width and height are specified in percents"
                }
              ],
              "default": "maximumArea",
              "displayOptions": {
                "show": {
                  "operation": [
                    "resize"
                  ]
                }
              },
              "description": "How to resize the image"
            },
            {
              "displayName": "Rotate",
              "name": "rotate",
              "type": "number",
              "typeOptions": {
                "minValue": -360,
                "maxValue": 360
              },
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "rotate"
                  ]
                }
              },
              "description": "How much the image should be rotated"
            },
            {
              "displayName": "Background Color",
              "name": "backgroundColor",
              "type": "color",
              "default": "#ffffffff",
              "typeOptions": {
                "showAlpha": true
              },
              "displayOptions": {
                "show": {
                  "operation": [
                    "rotate"
                  ]
                }
              },
              "description": "The color to use for the background when image gets rotated by anything which is not a multiple of 90"
            },
            {
              "displayName": "Degrees X",
              "name": "degreesX",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "shear"
                  ]
                }
              },
              "description": "X (horizontal) shear degrees"
            },
            {
              "displayName": "Degrees Y",
              "name": "degreesY",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "operation": [
                    "shear"
                  ]
                }
              },
              "description": "Y (vertical) shear degrees"
            },
            {
              "displayName": "Color",
              "name": "color",
              "type": "color",
              "default": "#ff0000",
              "displayOptions": {
                "show": {
                  "operation": [
                    "transparent"
                  ]
                }
              },
              "description": "The color to make transparent"
            },
            {
              "displayName": "Font Name or ID",
              "name": "font",
              "type": "options",
              "displayOptions": {
                "show": {
                  "operation": [
                    "text"
                  ]
                }
              },
              "typeOptions": {
                "loadOptionsMethod": "getFonts"
              },
              "default": "",
              "description": "The font to use. Defaults to Arial. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "multiStep"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Background Color",
      "name": "backgroundColor",
      "type": "color",
      "default": "#ffffff00",
      "description": "The background color of the image to create",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "showAlpha": true
      }
    },
    {
      "displayName": "Image Width",
      "name": "width",
      "type": "number",
      "default": 50,
      "description": "The width of the image to create",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Image Height",
      "name": "height",
      "type": "number",
      "default": 50,
      "description": "The height of the image to create",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Primitive",
      "name": "primitive",
      "type": "options",
      "default": "rectangle",
      "description": "The primitive to draw",
      "options": [
        {
          "name": "Circle",
          "value": "circle"
        },
        {
          "name": "Line",
          "value": "line"
        },
        {
          "name": "Rectangle",
          "value": "rectangle"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ]
        }
      }
    },
    {
      "displayName": "Color",
      "name": "color",
      "type": "color",
      "default": "#ff000000",
      "description": "The color of the primitive to draw",
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ]
        }
      },
      "typeOptions": {
        "showAlpha": true
      }
    },
    {
      "displayName": "Start Position X",
      "name": "startPositionX",
      "type": "number",
      "default": 50,
      "description": "X (horizontal) start position of the primitive",
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ],
          "primitive": [
            "circle",
            "line",
            "rectangle"
          ]
        }
      }
    },
    {
      "displayName": "Start Position Y",
      "name": "startPositionY",
      "type": "number",
      "default": 50,
      "description": "Y (horizontal) start position of the primitive",
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ],
          "primitive": [
            "circle",
            "line",
            "rectangle"
          ]
        }
      }
    },
    {
      "displayName": "End Position X",
      "name": "endPositionX",
      "type": "number",
      "default": 250,
      "description": "X (horizontal) end position of the primitive",
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ],
          "primitive": [
            "circle",
            "line",
            "rectangle"
          ]
        }
      }
    },
    {
      "displayName": "End Position Y",
      "name": "endPositionY",
      "type": "number",
      "default": 250,
      "description": "Y (horizontal) end position of the primitive",
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ],
          "primitive": [
            "circle",
            "line",
            "rectangle"
          ]
        }
      }
    },
    {
      "displayName": "Corner Radius",
      "name": "cornerRadius",
      "type": "number",
      "default": 0,
      "description": "The radius of the corner to create round corners",
      "displayOptions": {
        "show": {
          "operation": [
            "draw"
          ],
          "primitive": [
            "rectangle"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Text to write on the image",
      "displayOptions": {
        "show": {
          "operation": [
            "text"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Font Size",
      "name": "fontSize",
      "type": "number",
      "default": 18,
      "description": "Size of the text",
      "displayOptions": {
        "show": {
          "operation": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Font Color",
      "name": "fontColor",
      "type": "color",
      "default": "#000000",
      "description": "Color of the text",
      "displayOptions": {
        "show": {
          "operation": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Position X",
      "name": "positionX",
      "type": "number",
      "default": 50,
      "description": "X (horizontal) position of the text",
      "displayOptions": {
        "show": {
          "operation": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Position Y",
      "name": "positionY",
      "type": "number",
      "default": 50,
      "description": "Y (vertical) position of the text",
      "displayOptions": {
        "show": {
          "operation": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Max Line Length",
      "name": "lineLength",
      "type": "number",
      "default": 80,
      "description": "Max amount of characters in a line before a line-break should get added",
      "displayOptions": {
        "show": {
          "operation": [
            "text"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Blur",
      "name": "blur",
      "type": "number",
      "default": 5,
      "description": "How strong the blur should be",
      "displayOptions": {
        "show": {
          "operation": [
            "blur"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Sigma",
      "name": "sigma",
      "type": "number",
      "default": 2,
      "description": "The sigma of the blur",
      "displayOptions": {
        "show": {
          "operation": [
            "blur"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Border Width",
      "name": "borderWidth",
      "type": "number",
      "default": 10,
      "description": "The width of the border",
      "displayOptions": {
        "show": {
          "operation": [
            "border"
          ]
        }
      }
    },
    {
      "displayName": "Border Height",
      "name": "borderHeight",
      "type": "number",
      "default": 10,
      "description": "The height of the border",
      "displayOptions": {
        "show": {
          "operation": [
            "border"
          ]
        }
      }
    },
    {
      "displayName": "Border Color",
      "name": "borderColor",
      "type": "color",
      "default": "#000000",
      "description": "Color of the border",
      "displayOptions": {
        "show": {
          "operation": [
            "border"
          ]
        }
      }
    },
    {
      "displayName": "Composite Image Property",
      "name": "dataPropertyNameComposite",
      "type": "string",
      "default": "",
      "description": "The name of the binary property which contains the data of the image to composite on top of image which is found in Property Name",
      "displayOptions": {
        "show": {
          "operation": [
            "composite"
          ]
        }
      }
    },
    {
      "displayName": "Operator",
      "name": "operator",
      "type": "options",
      "default": "Over",
      "description": "The operator to use to combine the images",
      "options": [
        {
          "name": "Add",
          "value": "Add"
        },
        {
          "name": "Atop",
          "value": "Atop"
        },
        {
          "name": "Bumpmap",
          "value": "Bumpmap"
        },
        {
          "name": "Copy",
          "value": "Copy"
        },
        {
          "name": "Copy Black",
          "value": "CopyBlack"
        },
        {
          "name": "Copy Blue",
          "value": "CopyBlue"
        },
        {
          "name": "Copy Cyan",
          "value": "CopyCyan"
        },
        {
          "name": "Copy Green",
          "value": "CopyGreen"
        },
        {
          "name": "Copy Magenta",
          "value": "CopyMagenta"
        },
        {
          "name": "Copy Opacity",
          "value": "CopyOpacity"
        },
        {
          "name": "Copy Red",
          "value": "CopyRed"
        },
        {
          "name": "Copy Yellow",
          "value": "CopyYellow"
        },
        {
          "name": "Difference",
          "value": "Difference"
        },
        {
          "name": "Divide",
          "value": "Divide"
        },
        {
          "name": "In",
          "value": "In"
        },
        {
          "name": "Minus",
          "value": "Minus"
        },
        {
          "name": "Multiply",
          "value": "Multiply"
        },
        {
          "name": "Out",
          "value": "Out"
        },
        {
          "name": "Over",
          "value": "Over"
        },
        {
          "name": "Plus",
          "value": "Plus"
        },
        {
          "name": "Subtract",
          "value": "Subtract"
        },
        {
          "name": "Xor",
          "value": "Xor"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "composite"
          ]
        }
      }
    },
    {
      "displayName": "Position X",
      "name": "positionX",
      "type": "number",
      "default": 0,
      "description": "X (horizontal) position of composite image",
      "displayOptions": {
        "show": {
          "operation": [
            "composite"
          ]
        }
      }
    },
    {
      "displayName": "Position Y",
      "name": "positionY",
      "type": "number",
      "default": 0,
      "description": "Y (vertical) position of composite image",
      "displayOptions": {
        "show": {
          "operation": [
            "composite"
          ]
        }
      }
    },
    {
      "displayName": "Width",
      "name": "width",
      "type": "number",
      "default": 500,
      "description": "Crop width",
      "displayOptions": {
        "show": {
          "operation": [
            "crop"
          ]
        }
      }
    },
    {
      "displayName": "Height",
      "name": "height",
      "type": "number",
      "default": 500,
      "description": "Crop height",
      "displayOptions": {
        "show": {
          "operation": [
            "crop"
          ]
        }
      }
    },
    {
      "displayName": "Position X",
      "name": "positionX",
      "type": "number",
      "default": 0,
      "description": "X (horizontal) position to crop from",
      "displayOptions": {
        "show": {
          "operation": [
            "crop"
          ]
        }
      }
    },
    {
      "displayName": "Position Y",
      "name": "positionY",
      "type": "number",
      "default": 0,
      "description": "Y (vertical) position to crop from",
      "displayOptions": {
        "show": {
          "operation": [
            "crop"
          ]
        }
      }
    },
    {
      "displayName": "Width",
      "name": "width",
      "type": "number",
      "default": 500,
      "description": "New width of the image",
      "displayOptions": {
        "show": {
          "operation": [
            "resize"
          ]
        }
      }
    },
    {
      "displayName": "Height",
      "name": "height",
      "type": "number",
      "default": 500,
      "description": "New height of the image",
      "displayOptions": {
        "show": {
          "operation": [
            "resize"
          ]
        }
      }
    },
    {
      "displayName": "Option",
      "name": "resizeOption",
      "type": "options",
      "default": "maximumArea",
      "description": "How to resize the image",
      "options": [
        {
          "name": "Ignore Aspect Ratio",
          "value": "ignoreAspectRatio",
          "description": "Ignore aspect ratio and resize exactly to specified values"
        },
        {
          "name": "Maximum Area",
          "value": "maximumArea",
          "description": "Specified values are maximum area"
        },
        {
          "name": "Minimum Area",
          "value": "minimumArea",
          "description": "Specified values are minimum area"
        },
        {
          "name": "Only if Larger",
          "value": "onlyIfLarger",
          "description": "Resize only if image is larger than width or height"
        },
        {
          "name": "Only if Smaller",
          "value": "onlyIfSmaller",
          "description": "Resize only if image is smaller than width or height"
        },
        {
          "name": "Percent",
          "value": "percent",
          "description": "Width and height are specified in percents"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "resize"
          ]
        }
      }
    },
    {
      "displayName": "Rotate",
      "name": "rotate",
      "type": "number",
      "default": 0,
      "description": "How much the image should be rotated",
      "displayOptions": {
        "show": {
          "operation": [
            "rotate"
          ]
        }
      },
      "typeOptions": {
        "minValue": -360,
        "maxValue": 360
      }
    },
    {
      "displayName": "Background Color",
      "name": "backgroundColor",
      "type": "color",
      "default": "#ffffffff",
      "description": "The color to use for the background when image gets rotated by anything which is not a multiple of 90",
      "displayOptions": {
        "show": {
          "operation": [
            "rotate"
          ]
        }
      },
      "typeOptions": {
        "showAlpha": true
      }
    },
    {
      "displayName": "Degrees X",
      "name": "degreesX",
      "type": "number",
      "default": 0,
      "description": "X (horizontal) shear degrees",
      "displayOptions": {
        "show": {
          "operation": [
            "shear"
          ]
        }
      }
    },
    {
      "displayName": "Degrees Y",
      "name": "degreesY",
      "type": "number",
      "default": 0,
      "description": "Y (vertical) shear degrees",
      "displayOptions": {
        "show": {
          "operation": [
            "shear"
          ]
        }
      }
    },
    {
      "displayName": "Color",
      "name": "color",
      "type": "color",
      "default": "#ff0000",
      "description": "The color to make transparent",
      "displayOptions": {
        "show": {
          "operation": [
            "transparent"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Destination Output Field",
          "name": "destinationKey",
          "type": "string",
          "default": "data",
          "placeholder": "e.g image",
          "description": "The name of the output field that will contain the file data"
        },
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "File name to set in binary data"
        },
        {
          "displayName": "Font Name or ID",
          "name": "font",
          "type": "options",
          "displayOptions": {
            "show": {
              "/operation": [
                "text"
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getFonts"
          },
          "default": "",
          "description": "The font to use. Defaults to Arial. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "options": [
            {
              "name": "bmp",
              "value": "bmp"
            },
            {
              "name": "gif",
              "value": "gif"
            },
            {
              "name": "jpeg",
              "value": "jpeg"
            },
            {
              "name": "png",
              "value": "png"
            },
            {
              "name": "tiff",
              "value": "tiff"
            },
            {
              "name": "WebP",
              "value": "webp"
            }
          ],
          "default": "jpeg",
          "description": "Set the output image format"
        },
        {
          "displayName": "Quality",
          "name": "quality",
          "type": "number",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 100
          },
          "default": 100,
          "displayOptions": {
            "show": {
              "format": [
                "jpeg",
                "png",
                "tiff"
              ]
            }
          },
          "description": "Sets the jpeg|png|tiff compression level from 0 to 100 (best)"
        }
      ],
      "displayOptions": {
        "hide": {
          "operation": [
            "information"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "blur",
      "name": "Blur",
      "description": "Adds a blur to the image and so makes it less sharp"
    },
    {
      "operation": "border",
      "name": "Border",
      "description": "Adds a border to the image"
    },
    {
      "operation": "composite",
      "name": "Composite",
      "description": "Composite image on top of another one"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new image"
    },
    {
      "operation": "crop",
      "name": "Crop",
      "description": "Crops the image"
    },
    {
      "operation": "draw",
      "name": "Draw",
      "description": "Draw on image"
    },
    {
      "operation": "information",
      "name": "Get Information",
      "description": "Returns image information like resolution"
    },
    {
      "operation": "multiStep",
      "name": "Multi Step",
      "description": "Perform multiple operations"
    },
    {
      "operation": "resize",
      "name": "Resize",
      "description": "Change the size of image"
    },
    {
      "operation": "rotate",
      "name": "Rotate",
      "description": "Rotate image"
    },
    {
      "operation": "shear",
      "name": "Shear",
      "description": "Shear image along the X or Y axis"
    },
    {
      "operation": "text",
      "name": "Text",
      "description": "Adds text to image"
    },
    {
      "operation": "transparent",
      "name": "Transparent",
      "description": "Make a color in image transparent"
    }
  ]


node_type: nodes-base.e2eTestTool
package_name: n8n-nodes-base
display_name: E2E Test Tool
description: Dummy node used for e2e testing (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
credentials_required: []
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.e2eTest
properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with E2E Test"
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "remoteOptions",
      "options": [
        {
          "name": "Remote Options",
          "value": "remoteOptions"
        },
        {
          "name": "Resource Locator",
          "value": "resourceLocator"
        },
        {
          "name": "Resource Mapping Component",
          "value": "resourceMapper"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Field ID",
      "name": "fieldId",
      "type": "string",
      "default": ""
    },
    {
      "displayName": "Remote Options Name or ID",
      "name": "remoteOptions",
      "type": "options",
      "default": [],
      "description": "Remote options to load. 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": [
            "remoteOptions"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "fieldId"
        ],
        "loadOptionsMethod": "getOptions"
      }
    },
    {
      "displayName": "Resource Locator",
      "name": "rlc",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "resourceLocator"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "typeOptions": {
            "searchListMethod": "optionsSearch",
            "searchable": true
          }
        },
        {
          "displayName": "By URL",
          "name": "url",
          "type": "string",
          "placeholder": "https://example.com/user/a4071e98-7d40-41fb-8911-ce3e7bf94fb2",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "https://example.com/user/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
                "errorMessage": "Not a valid example URL"
              }
            }
          ],
          "extractValue": {
            "type": "regex",
            "regex": "https://example.com/user/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})"
          }
        },
        {
          "displayName": "ID",
          "name": "id",
          "type": "string",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
                "errorMessage": "Not a valid UUI"
              }
            }
          ],
          "placeholder": "a4071e98-7d40-41fb-8911-ce3e7bf94fb2"
        }
      ]
    },
    {
      "displayName": "Resource Mapping Component",
      "name": "resourceMapper",
      "type": "resourceMapper",
      "default": {
        "mappingMode": "defineBelow",
        "value": null
      },
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "resourceMapper"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "fieldId"
        ],
        "resourceMapper": {
          "resourceMapperMethod": "getMappingColumns",
          "mode": "upsert",
          "fieldWords": {
            "singular": "column",
            "plural": "columns"
          },
          "addAllFields": true,
          "multiKeyMatch": false
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Other Non Important Field",
      "name": "otherField",
      "type": "string",
      "default": ""
    }
  ]

operations:
  [
    {
      "operation": "remoteOptions",
      "name": "Remote Options"
    },
    {
      "operation": "resourceLocator",
      "name": "Resource Locator"
    },
    {
      "operation": "resourceMapper",
      "name": "Resource Mapping Component"
    }
  ]


node_type: nodes-base.e2eTest
package_name: n8n-nodes-base
display_name: E2E Test
description: Dummy node used for e2e testing
category: output
development_style: programmatic
version: 1
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "remoteOptions",
      "options": [
        {
          "name": "Remote Options",
          "value": "remoteOptions"
        },
        {
          "name": "Resource Locator",
          "value": "resourceLocator"
        },
        {
          "name": "Resource Mapping Component",
          "value": "resourceMapper"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Field ID",
      "name": "fieldId",
      "type": "string",
      "default": ""
    },
    {
      "displayName": "Remote Options Name or ID",
      "name": "remoteOptions",
      "type": "options",
      "default": [],
      "description": "Remote options to load. 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": [
            "remoteOptions"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "fieldId"
        ],
        "loadOptionsMethod": "getOptions"
      }
    },
    {
      "displayName": "Resource Locator",
      "name": "rlc",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "resourceLocator"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "typeOptions": {
            "searchListMethod": "optionsSearch",
            "searchable": true
          }
        },
        {
          "displayName": "By URL",
          "name": "url",
          "type": "string",
          "placeholder": "https://example.com/user/a4071e98-7d40-41fb-8911-ce3e7bf94fb2",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "https://example.com/user/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
                "errorMessage": "Not a valid example URL"
              }
            }
          ],
          "extractValue": {
            "type": "regex",
            "regex": "https://example.com/user/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})"
          }
        },
        {
          "displayName": "ID",
          "name": "id",
          "type": "string",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
                "errorMessage": "Not a valid UUI"
              }
            }
          ],
          "placeholder": "a4071e98-7d40-41fb-8911-ce3e7bf94fb2"
        }
      ]
    },
    {
      "displayName": "Resource Mapping Component",
      "name": "resourceMapper",
      "type": "resourceMapper",
      "default": {
        "mappingMode": "defineBelow",
        "value": null
      },
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "resourceMapper"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "fieldId"
        ],
        "resourceMapper": {
          "resourceMapperMethod": "getMappingColumns",
          "mode": "upsert",
          "fieldWords": {
            "singular": "column",
            "plural": "columns"
          },
          "addAllFields": true,
          "multiKeyMatch": false
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Other Non Important Field",
      "name": "otherField",
      "type": "string",
      "default": ""
    }
  ]

operations:
  [
    {
      "operation": "remoteOptions",
      "name": "Remote Options"
    },
    {
      "operation": "resourceLocator",
      "name": "Resource Locator"
    },
    {
      "operation": "resourceMapper",
      "name": "Resource Mapping Component"
    }
  ]


node_type: nodes-base.egoiTool
package_name: n8n-nodes-base
display_name: E-goi Tool
description: Consume E-goi API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "egoiApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.egoi
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: E-goi node documentation
  description: Learn how to use the E=goi node in n8n. Follow technical documentation to integrate E=goi node into your workflows.
  contentType: [integration, reference]
  ---

  # E-goi node

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

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

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

  ## Operations

  **Contact**

  - Create a member
  - Get a member
  - Get all members
  - Update a member

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with E-goi"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a member",
          "action": "Create a member"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a member",
          "action": "Get a member"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members",
          "action": "Get many members"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a member",
          "action": "Update a member"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "ID of list to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "create",
            "update",
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address for a subscriber",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Contact ID of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response just includes the contact ID. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Birth Date",
          "name": "birth_date",
          "type": "dateTime",
          "default": "",
          "description": "Birth date of a subscriber"
        },
        {
          "displayName": "Cellphone",
          "name": "cellphone",
          "type": "string",
          "default": "",
          "description": "Cellphone of a subscriber"
        },
        {
          "displayName": "Extra Fields",
          "name": "extraFieldsUi",
          "type": "fixedCollection",
          "placeholder": "Add Field",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Extra Field",
              "name": "extraFieldValues",
              "typeOptions": {
                "multipleValueButtonText": "Add Field"
              },
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field_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": "getExtraFields",
                    "loadOptionsDependsOn": [
                      "list"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "Name of a subscriber"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "Name of a subscriber"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            },
            {
              "name": "Removed",
              "value": "removed"
            }
          ],
          "default": "active",
          "description": "Subscriber's current status"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tagIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getListTags"
          },
          "default": [],
          "description": "List of tag IDs to be added. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Birth Date",
          "name": "birth_date",
          "type": "dateTime",
          "default": "",
          "description": "Birth date of subscriber"
        },
        {
          "displayName": "Cellphone",
          "name": "cellphone",
          "type": "string",
          "default": "",
          "description": "Cellphone of subscriber"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email address for subscriber"
        },
        {
          "displayName": "Extra Fields",
          "name": "extraFieldsUi",
          "type": "fixedCollection",
          "placeholder": "Add Field",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Extra Field",
              "name": "extraFieldValues",
              "typeOptions": {
                "multipleValueButtonText": "Add Field"
              },
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field_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": "getExtraFields",
                    "loadOptionsDependsOn": [
                      "list"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "Name of subscriber"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "Name of subscriber"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            },
            {
              "name": "Removed",
              "value": "removed"
            }
          ],
          "default": "active",
          "description": "Subscriber's current status"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tagIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getListTags"
          },
          "default": [],
          "description": "List of tag IDs to be added. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "id",
      "description": "Search by",
      "options": [
        {
          "name": "Contact ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Contact ID of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address for subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "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": [
            "getAll"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "contact"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "getAll"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: E-goi node documentation
  description: Learn how to use the E=goi node in n8n. Follow technical documentation to integrate E=goi node into your workflows.
  contentType: [integration, reference]
  ---

  # E-goi node

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

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

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

  ## Operations

  **Contact**

  - Create a member
  - Get a member
  - Get all members
  - Update a member

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a member",
          "action": "Create a member"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a member",
          "action": "Get a member"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members",
          "action": "Get many members"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a member",
          "action": "Update a member"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "ID of list to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "create",
            "update",
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address for a subscriber",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Contact ID of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response just includes the contact ID. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Birth Date",
          "name": "birth_date",
          "type": "dateTime",
          "default": "",
          "description": "Birth date of a subscriber"
        },
        {
          "displayName": "Cellphone",
          "name": "cellphone",
          "type": "string",
          "default": "",
          "description": "Cellphone of a subscriber"
        },
        {
          "displayName": "Extra Fields",
          "name": "extraFieldsUi",
          "type": "fixedCollection",
          "placeholder": "Add Field",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Extra Field",
              "name": "extraFieldValues",
              "typeOptions": {
                "multipleValueButtonText": "Add Field"
              },
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field_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": "getExtraFields",
                    "loadOptionsDependsOn": [
                      "list"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "Name of a subscriber"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "Name of a subscriber"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            },
            {
              "name": "Removed",
              "value": "removed"
            }
          ],
          "default": "active",
          "description": "Subscriber's current status"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tagIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getListTags"
          },
          "default": [],
          "description": "List of tag IDs to be added. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Birth Date",
          "name": "birth_date",
          "type": "dateTime",
          "default": "",
          "description": "Birth date of subscriber"
        },
        {
          "displayName": "Cellphone",
          "name": "cellphone",
          "type": "string",
          "default": "",
          "description": "Cellphone of subscriber"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email address for subscriber"
        },
        {
          "displayName": "Extra Fields",
          "name": "extraFieldsUi",
          "type": "fixedCollection",
          "placeholder": "Add Field",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Extra Field",
              "name": "extraFieldValues",
              "typeOptions": {
                "multipleValueButtonText": "Add Field"
              },
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field_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": "getExtraFields",
                    "loadOptionsDependsOn": [
                      "list"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "Name of subscriber"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "Name of subscriber"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            },
            {
              "name": "Removed",
              "value": "removed"
            }
          ],
          "default": "active",
          "description": "Subscriber's current status"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tagIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getListTags"
          },
          "default": [],
          "description": "List of tag IDs to be added. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "id",
      "description": "Search by",
      "options": [
        {
          "name": "Contact ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Contact ID of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address for subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "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": [
            "getAll"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "contact"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "getAll"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    }
  ]

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


node_type: nodes-base.elasticsearchTool
package_name: n8n-nodes-base
display_name: Elasticsearch Tool
description: Consume the Elasticsearch API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "elasticsearchApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.elasticsearch
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Elasticsearch node documentation
  description: Learn how to use the Elasticsearch node in n8n. Follow technical documentation to integrate Elasticsearch node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Elasticsearch node

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

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

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

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

  ## Operations

  * Document
      * Create a document
      * Delete a document
      * Get a document
      * Get all documents
      * Update a document
  * Index
      * Create
      * Delete
      * Get
      * Get All

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Elasticsearch"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "document",
      "options": [
        {
          "name": "Document",
          "value": "document"
        },
        {
          "name": "Index",
          "value": "index"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a document",
          "action": "Create a document"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a document",
          "action": "Delete a document"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a document",
          "action": "Get a document"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many documents",
          "action": "Get many documents"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a document",
          "action": "Update a document"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index containing the document to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Document ID",
      "name": "documentId",
      "type": "string",
      "default": "",
      "description": "ID of the document to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bulk Delete",
          "name": "bulkOperation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the bulk operation to delete the document/s"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index containing the document to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Document ID",
      "name": "documentId",
      "type": "string",
      "default": "",
      "description": "ID of the document to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Source Excludes",
          "name": "_source_excludes",
          "description": "Comma-separated list of source fields to exclude from the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Includes",
          "name": "_source_includes",
          "description": "Comma-separated list of source fields to include in the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Stored Fields",
          "name": "stored_fields",
          "description": "Whether to retrieve the document fields stored in the index rather than the document <code>_source</code>. Defaults to false.",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index containing the documents to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "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": [
            "document"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "By default, you cannot page through more than 10,000 hits. To page through more hits, add \"Sort\" from options.",
      "name": "paginateNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allow No Indices",
          "name": "allow_no_indices",
          "description": "If false, return an error if any of the following targets only missing/closed indices: wildcard expression, index alias, or <code>_all</code> value. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Allow Partial Search Results",
          "name": "allow_partial_search_results",
          "description": "<p>If true, return partial results if there are shard request timeouts or shard failures.</p><p>If false, returns an error with no partial results. Defaults to true.</p>.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Batched Reduce Size",
          "name": "batched_reduce_size",
          "description": "Number of shard results that should be reduced at once on the coordinating node. Defaults to 512.",
          "type": "number",
          "typeOptions": {
            "minValue": 2
          },
          "default": 512
        },
        {
          "displayName": "CCS Minimize Roundtrips",
          "name": "ccs_minimize_roundtrips",
          "description": "Whether network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Doc Value Fields",
          "name": "docvalue_fields",
          "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Expand Wildcards",
          "name": "expand_wildcards",
          "description": "Type of index that wildcard expressions can match. Defaults to <code>open</code>",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Hidden",
              "value": "hidden"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Open",
              "value": "open"
            }
          ],
          "default": "open"
        },
        {
          "displayName": "Explain",
          "name": "explain",
          "description": "Whether to return detailed information about score computation as part of a hit. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Ignore Throttled",
          "name": "ignore_throttled",
          "description": "Whether concrete, expanded or aliased indices are ignored when frozen. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Ignore Unavailable",
          "name": "ignore_unavailable",
          "description": "Whether missing or closed indices are not included in the response. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Max Concurrent Shard Requests",
          "name": "max_concurrent_shard_requests",
          "description": "Define the number of shard requests per node this search executes concurrently. Defaults to 5.",
          "type": "number",
          "default": 5
        },
        {
          "displayName": "Pre-Filter Shard Size",
          "name": "pre_filter_shard_size",
          "description": "Define a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting. Only used if the number of shards the search request expands to exceeds the threshold.",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 1
        },
        {
          "displayName": "Query",
          "name": "query",
          "description": "Query in the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html\">Elasticsearch Query DSL</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"query\": {\n    \"term\": {\n      \"user.id\": \"john\"\n    }\n  }\n}"
        },
        {
          "displayName": "Request Cache",
          "name": "request_cache",
          "description": "Whether the caching of search results is enabled for requests where size is 0. See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-request-cache.html\">Elasticsearch shard request cache settings</a>.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Routing",
          "name": "routing",
          "description": "Target this primary shard",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Search Type",
          "name": "search_type",
          "description": "How distributed term frequencies are calculated for relevance scoring. Defaults to Query then Fetch.",
          "type": "options",
          "options": [
            {
              "name": "DFS Query Then Fetch",
              "value": "dfs_query_then_fetch"
            },
            {
              "name": "Query Then Fetch",
              "value": "query_then_fetch"
            }
          ],
          "default": "query_then_fetch"
        },
        {
          "displayName": "Sequence Number and Primary Term",
          "name": "seq_no_primary_term",
          "description": "Whether to return the sequence number and primary term of the last modification of each hit. See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html\">Optimistic concurrency control</a>.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "description": "Comma-separated list of <code>field:direction</code> pairs",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Excludes",
          "name": "_source_excludes",
          "description": "Comma-separated list of source fields to exclude from the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Includes",
          "name": "_source_includes",
          "description": "Comma-separated list of source fields to include in the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Stats",
          "name": "stats",
          "description": "Tag of the request for logging and statistical purposes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Stored Fields",
          "name": "stored_fields",
          "description": "Whether to retrieve the document fields stored in the index rather than the document <code>_source</code>. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Terminate After",
          "name": "terminate_after",
          "description": "Max number of documents to collect for each shard",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "description": "Period to wait for active shards. Defaults to <code>1m</code> (one minute). See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        },
        {
          "displayName": "Track Scores",
          "name": "track_scores",
          "description": "Whether to calculate and return document scores, even if the scores are not used for sorting. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Total Hits",
          "name": "track_total_hits",
          "description": "Number of hits matching the query to count accurately. Defaults to 10000.",
          "type": "number",
          "default": 10000
        },
        {
          "displayName": "Version",
          "name": "version",
          "description": "Whether to return document version as part of a hit. Defaults to false.",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to add the document to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        },
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Document ID",
          "name": "documentId",
          "description": "ID of the document to create and add to the index",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Routing",
          "name": "routing",
          "description": "Target this primary shard",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "description": "Period to wait for active shards. Defaults to <code>1m</code> (one minute). See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bulk Create",
          "name": "bulkOperation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the bulk operation to create the document/s"
        },
        {
          "displayName": "Pipeline ID",
          "name": "pipeline",
          "description": "ID of the pipeline to use to preprocess incoming documents",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Refresh",
          "name": "refresh",
          "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search,if wait_for then wait for a refresh to make this operation visible to search,if false do nothing with refreshes",
          "type": "options",
          "default": "false",
          "options": [
            {
              "name": "True",
              "value": "true",
              "description": "Refreshes the affected shards to make this operation visible to search"
            },
            {
              "name": "Wait For",
              "value": "wait_for",
              "description": "Wait for a refresh to make this operation visible"
            },
            {
              "name": "False",
              "value": "false",
              "description": "Do nothing with refreshes"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the document to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Document ID",
      "name": "documentId",
      "type": "string",
      "default": "",
      "description": "ID of the document to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        },
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bulk Update",
          "name": "bulkOperation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the bulk operation to update the document/s"
        },
        {
          "displayName": "Refresh",
          "name": "refresh",
          "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search,if wait_for then wait for a refresh to make this operation visible to search,if false do nothing with refreshes",
          "type": "options",
          "default": "false",
          "options": [
            {
              "name": "True",
              "value": "true",
              "description": "Refreshes the affected shards to make this operation visible to search"
            },
            {
              "name": "Wait For",
              "value": "wait_for",
              "description": "Wait for a refresh to make this operation visible"
            },
            {
              "name": "False",
              "value": "false",
              "description": "Do nothing with refreshes"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an index"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an index"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an index"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many indices"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Aliases",
          "name": "aliases",
          "description": "Index aliases which include the index, as an <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html\">alias object</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"aliases\": {\n    \"alias_1\": {},\n    \"alias_2\": {\n      \"filter\": {\n        \"term\": { \"user.id\": \"kimchy\" }\n      },\n      \"routing\": \"shard-1\"\n    }\n  }\n}"
        },
        {
          "displayName": "Include Type Name",
          "name": "include_type_name",
          "description": "Whether a mapping type is expected in the body of mappings. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Mappings",
          "name": "mappings",
          "description": "Mapping for fields in the index, as <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html\">mapping object</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"mappings\": {\n    \"properties\": {\n      \"field1\": { \"type\": \"text\" }\n    }\n  }\n}"
        },
        {
          "displayName": "Master Timeout",
          "name": "master_timeout",
          "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to <code>1m</code>. See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        },
        {
          "displayName": "Settings",
          "name": "settings",
          "description": "Configuration options for the index, as an <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings\">index settings object</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"settings\": {\n    \"index\": {\n      \"number_of_shards\": 3,\n      \"number_of_replicas\": 2\n    }\n  }\n}"
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to <code>30s</code>. See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "30s"
        },
        {
          "displayName": "Wait for Active Shards",
          "name": "wait_for_active_shards",
          "description": "The number of shard copies that must be active before proceeding with the operation. Set to <code>all</code> or any positive integer up to the total number of shards in the index. Default: 1, the primary shard",
          "type": "string",
          "default": "1"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allow No Indices",
          "name": "allow_no_indices",
          "description": "If false, return an error if any of the following targets only missing/closed indices: wildcard expression, index alias, or <code>_all</code> value. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Expand Wildcards",
          "name": "expand_wildcards",
          "description": "Type of index that wildcard expressions can match. Defaults to <code>open</code>",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Hidden",
              "value": "hidden"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Open",
              "value": "open"
            }
          ],
          "default": "all"
        },
        {
          "displayName": "Flat Settings",
          "name": "flat_settings",
          "description": "Whether to return settings in flat format. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Ignore Unavailable",
          "name": "ignore_unavailable",
          "description": "Whether to request that target a missing index return an error. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Include Defaults",
          "name": "include_defaults",
          "description": "Whether to return all default settings in the response. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Local",
          "name": "local",
          "description": "Whether to retrieve information from the local node only. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Master Timeout",
          "name": "master_timeout",
          "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to <code>1m</code>. See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "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": [
            "index"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Elasticsearch node documentation
  description: Learn how to use the Elasticsearch node in n8n. Follow technical documentation to integrate Elasticsearch node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Elasticsearch node

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

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

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

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

  ## Operations

  * Document
      * Create a document
      * Delete a document
      * Get a document
      * Get all documents
      * Update a document
  * Index
      * Create
      * Delete
      * Get
      * Get All

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "document",
      "options": [
        {
          "name": "Document",
          "value": "document"
        },
        {
          "name": "Index",
          "value": "index"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a document",
          "action": "Create a document"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a document",
          "action": "Delete a document"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a document",
          "action": "Get a document"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many documents",
          "action": "Get many documents"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a document",
          "action": "Update a document"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index containing the document to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Document ID",
      "name": "documentId",
      "type": "string",
      "default": "",
      "description": "ID of the document to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bulk Delete",
          "name": "bulkOperation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the bulk operation to delete the document/s"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index containing the document to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Document ID",
      "name": "documentId",
      "type": "string",
      "default": "",
      "description": "ID of the document to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Source Excludes",
          "name": "_source_excludes",
          "description": "Comma-separated list of source fields to exclude from the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Includes",
          "name": "_source_includes",
          "description": "Comma-separated list of source fields to include in the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Stored Fields",
          "name": "stored_fields",
          "description": "Whether to retrieve the document fields stored in the index rather than the document <code>_source</code>. Defaults to false.",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index containing the documents to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "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": [
            "document"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "By default, you cannot page through more than 10,000 hits. To page through more hits, add \"Sort\" from options.",
      "name": "paginateNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allow No Indices",
          "name": "allow_no_indices",
          "description": "If false, return an error if any of the following targets only missing/closed indices: wildcard expression, index alias, or <code>_all</code> value. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Allow Partial Search Results",
          "name": "allow_partial_search_results",
          "description": "<p>If true, return partial results if there are shard request timeouts or shard failures.</p><p>If false, returns an error with no partial results. Defaults to true.</p>.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Batched Reduce Size",
          "name": "batched_reduce_size",
          "description": "Number of shard results that should be reduced at once on the coordinating node. Defaults to 512.",
          "type": "number",
          "typeOptions": {
            "minValue": 2
          },
          "default": 512
        },
        {
          "displayName": "CCS Minimize Roundtrips",
          "name": "ccs_minimize_roundtrips",
          "description": "Whether network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Doc Value Fields",
          "name": "docvalue_fields",
          "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Expand Wildcards",
          "name": "expand_wildcards",
          "description": "Type of index that wildcard expressions can match. Defaults to <code>open</code>",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Hidden",
              "value": "hidden"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Open",
              "value": "open"
            }
          ],
          "default": "open"
        },
        {
          "displayName": "Explain",
          "name": "explain",
          "description": "Whether to return detailed information about score computation as part of a hit. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Ignore Throttled",
          "name": "ignore_throttled",
          "description": "Whether concrete, expanded or aliased indices are ignored when frozen. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Ignore Unavailable",
          "name": "ignore_unavailable",
          "description": "Whether missing or closed indices are not included in the response. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Max Concurrent Shard Requests",
          "name": "max_concurrent_shard_requests",
          "description": "Define the number of shard requests per node this search executes concurrently. Defaults to 5.",
          "type": "number",
          "default": 5
        },
        {
          "displayName": "Pre-Filter Shard Size",
          "name": "pre_filter_shard_size",
          "description": "Define a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting. Only used if the number of shards the search request expands to exceeds the threshold.",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 1
        },
        {
          "displayName": "Query",
          "name": "query",
          "description": "Query in the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html\">Elasticsearch Query DSL</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"query\": {\n    \"term\": {\n      \"user.id\": \"john\"\n    }\n  }\n}"
        },
        {
          "displayName": "Request Cache",
          "name": "request_cache",
          "description": "Whether the caching of search results is enabled for requests where size is 0. See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-request-cache.html\">Elasticsearch shard request cache settings</a>.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Routing",
          "name": "routing",
          "description": "Target this primary shard",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Search Type",
          "name": "search_type",
          "description": "How distributed term frequencies are calculated for relevance scoring. Defaults to Query then Fetch.",
          "type": "options",
          "options": [
            {
              "name": "DFS Query Then Fetch",
              "value": "dfs_query_then_fetch"
            },
            {
              "name": "Query Then Fetch",
              "value": "query_then_fetch"
            }
          ],
          "default": "query_then_fetch"
        },
        {
          "displayName": "Sequence Number and Primary Term",
          "name": "seq_no_primary_term",
          "description": "Whether to return the sequence number and primary term of the last modification of each hit. See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html\">Optimistic concurrency control</a>.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "description": "Comma-separated list of <code>field:direction</code> pairs",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Excludes",
          "name": "_source_excludes",
          "description": "Comma-separated list of source fields to exclude from the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Includes",
          "name": "_source_includes",
          "description": "Comma-separated list of source fields to include in the response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Stats",
          "name": "stats",
          "description": "Tag of the request for logging and statistical purposes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Stored Fields",
          "name": "stored_fields",
          "description": "Whether to retrieve the document fields stored in the index rather than the document <code>_source</code>. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Terminate After",
          "name": "terminate_after",
          "description": "Max number of documents to collect for each shard",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "description": "Period to wait for active shards. Defaults to <code>1m</code> (one minute). See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        },
        {
          "displayName": "Track Scores",
          "name": "track_scores",
          "description": "Whether to calculate and return document scores, even if the scores are not used for sorting. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Total Hits",
          "name": "track_total_hits",
          "description": "Number of hits matching the query to count accurately. Defaults to 10000.",
          "type": "number",
          "default": 10000
        },
        {
          "displayName": "Version",
          "name": "version",
          "description": "Whether to return document version as part of a hit. Defaults to false.",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to add the document to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        },
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Document ID",
          "name": "documentId",
          "description": "ID of the document to create and add to the index",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Routing",
          "name": "routing",
          "description": "Target this primary shard",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "description": "Period to wait for active shards. Defaults to <code>1m</code> (one minute). See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bulk Create",
          "name": "bulkOperation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the bulk operation to create the document/s"
        },
        {
          "displayName": "Pipeline ID",
          "name": "pipeline",
          "description": "ID of the pipeline to use to preprocess incoming documents",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Refresh",
          "name": "refresh",
          "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search,if wait_for then wait for a refresh to make this operation visible to search,if false do nothing with refreshes",
          "type": "options",
          "default": "false",
          "options": [
            {
              "name": "True",
              "value": "true",
              "description": "Refreshes the affected shards to make this operation visible to search"
            },
            {
              "name": "Wait For",
              "value": "wait_for",
              "description": "Wait for a refresh to make this operation visible"
            },
            {
              "name": "False",
              "value": "false",
              "description": "Do nothing with refreshes"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the document to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Document ID",
      "name": "documentId",
      "type": "string",
      "default": "",
      "description": "ID of the document to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        },
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bulk Update",
          "name": "bulkOperation",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the bulk operation to update the document/s"
        },
        {
          "displayName": "Refresh",
          "name": "refresh",
          "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search,if wait_for then wait for a refresh to make this operation visible to search,if false do nothing with refreshes",
          "type": "options",
          "default": "false",
          "options": [
            {
              "name": "True",
              "value": "true",
              "description": "Refreshes the affected shards to make this operation visible to search"
            },
            {
              "name": "Wait For",
              "value": "wait_for",
              "description": "Wait for a refresh to make this operation visible"
            },
            {
              "name": "False",
              "value": "false",
              "description": "Do nothing with refreshes"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "document"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an index"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an index"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an index"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many indices"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Aliases",
          "name": "aliases",
          "description": "Index aliases which include the index, as an <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html\">alias object</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"aliases\": {\n    \"alias_1\": {},\n    \"alias_2\": {\n      \"filter\": {\n        \"term\": { \"user.id\": \"kimchy\" }\n      },\n      \"routing\": \"shard-1\"\n    }\n  }\n}"
        },
        {
          "displayName": "Include Type Name",
          "name": "include_type_name",
          "description": "Whether a mapping type is expected in the body of mappings. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Mappings",
          "name": "mappings",
          "description": "Mapping for fields in the index, as <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html\">mapping object</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"mappings\": {\n    \"properties\": {\n      \"field1\": { \"type\": \"text\" }\n    }\n  }\n}"
        },
        {
          "displayName": "Master Timeout",
          "name": "master_timeout",
          "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to <code>1m</code>. See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        },
        {
          "displayName": "Settings",
          "name": "settings",
          "description": "Configuration options for the index, as an <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings\">index settings object</a>",
          "type": "json",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "placeholder": "{\n  \"settings\": {\n    \"index\": {\n      \"number_of_shards\": 3,\n      \"number_of_replicas\": 2\n    }\n  }\n}"
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to <code>30s</code>. See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "30s"
        },
        {
          "displayName": "Wait for Active Shards",
          "name": "wait_for_active_shards",
          "description": "The number of shard copies that must be active before proceeding with the operation. Set to <code>all</code> or any positive integer up to the total number of shards in the index. Default: 1, the primary shard",
          "type": "string",
          "default": "1"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Index ID",
      "name": "indexId",
      "type": "string",
      "default": "",
      "description": "ID of the index to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allow No Indices",
          "name": "allow_no_indices",
          "description": "If false, return an error if any of the following targets only missing/closed indices: wildcard expression, index alias, or <code>_all</code> value. Defaults to true.",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Expand Wildcards",
          "name": "expand_wildcards",
          "description": "Type of index that wildcard expressions can match. Defaults to <code>open</code>",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Hidden",
              "value": "hidden"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Open",
              "value": "open"
            }
          ],
          "default": "all"
        },
        {
          "displayName": "Flat Settings",
          "name": "flat_settings",
          "description": "Whether to return settings in flat format. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Ignore Unavailable",
          "name": "ignore_unavailable",
          "description": "Whether to request that target a missing index return an error. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Include Defaults",
          "name": "include_defaults",
          "description": "Whether to return all default settings in the response. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Local",
          "name": "local",
          "description": "Whether to retrieve information from the local node only. Defaults to false.",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Master Timeout",
          "name": "master_timeout",
          "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to <code>1m</code>. See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>",
          "type": "string",
          "default": "1m"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "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": [
            "index"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "index"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

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


node_type: nodes-base.elasticSecurityTool
package_name: n8n-nodes-base
display_name: Elastic Security Tool
description: Consume the Elastic Security API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "elasticSecurityApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.elasticSecurity
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Elastic Security node documentation
  description: Learn how to use the Elastic Security node in n8n. Follow technical documentation to integrate Elastic Security node into your workflows.
  contentType: [integration, reference]
  ---

  # Elastic Security node

  Use the Elastic Security node to automate work in Elastic Security, and integrate Elastic Security with other applications. n8n's has built-in support for a wide range of Elastic Security features, including creating, updating, deleting, retrieving, and getting cases.

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

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

  ## Operations

  * Case
      * Create a case
      * Delete a case
      * Get a case
      * Retrieve all cases
      * Retrieve a summary of all case activity
      * Update a case
  * Case Comment
      * Add a comment to a case
      * Get a case comment
      * Retrieve all case comments
      * Remove a comment from a case
      * Update a comment in a case
  * Case Tag
      * Add a tag to a case
      * Remove a tag from a case
  * Connector
      * Create a connector

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Elastic Security"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "case",
      "options": [
        {
          "name": "Case",
          "value": "case"
        },
        {
          "name": "Case Comment",
          "value": "caseComment"
        },
        {
          "name": "Case Tag",
          "value": "caseTag"
        },
        {
          "name": "Connector",
          "value": "connector"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a case",
          "action": "Create a case"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a case",
          "action": "Delete a case"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a case",
          "action": "Get a case"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many cases",
          "action": "Get many cases"
        },
        {
          "name": "Get Status",
          "value": "getStatus",
          "description": "Retrieve a summary of all case activity",
          "action": "Get the status of a case"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a case",
          "action": "Update a case"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Connector Name or ID",
      "name": "connectorId",
      "type": "options",
      "default": "",
      "description": "Connectors allow you to send Elastic Security cases into other systems (only ServiceNow, Jira, or IBM Resilient). 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": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getConnectors"
      }
    },
    {
      "displayName": "Connector Type",
      "name": "connectorType",
      "type": "options",
      "default": ".jira",
      "options": [
        {
          "name": "IBM Resilient",
          "value": ".resilient"
        },
        {
          "name": "Jira",
          "value": ".jira"
        },
        {
          "name": "ServiceNow ITSM",
          "value": ".servicenow"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Issue Type",
      "name": "issueType",
      "type": "string",
      "default": "",
      "description": "Type of the Jira issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "Priority",
      "name": "priority",
      "type": "string",
      "default": "",
      "description": "Priority of the Jira issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "Urgency",
      "name": "urgency",
      "type": "options",
      "default": 1,
      "description": "Urgency of the ServiceNow ITSM issue to create for this case",
      "options": [
        {
          "name": "Low",
          "value": 1
        },
        {
          "name": "Medium",
          "value": 2
        },
        {
          "name": "High",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Severity",
      "name": "severity",
      "type": "options",
      "default": 1,
      "description": "Severity of the ServiceNow ITSM issue to create for this case",
      "options": [
        {
          "name": "Low",
          "value": 1
        },
        {
          "name": "Medium",
          "value": 2
        },
        {
          "name": "High",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Impact",
      "name": "impact",
      "type": "options",
      "default": 1,
      "description": "Impact of the ServiceNow ITSM issue to create for this case",
      "options": [
        {
          "name": "Low",
          "value": 1
        },
        {
          "name": "Medium",
          "value": 2
        },
        {
          "name": "High",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Category",
      "name": "category",
      "type": "string",
      "default": "",
      "description": "Category of the ServiceNow ITSM issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Issue Types",
      "name": "issueTypes",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of numerical types of the IBM Resilient issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      }
    },
    {
      "displayName": "Severity Code",
      "name": "severityCode",
      "type": "number",
      "default": 1,
      "description": "Severity code of the IBM Resilient issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "description": "Valid application owner registered within the Cases Role Based Access Control system",
          "default": ""
        },
        {
          "displayName": "Sync Alerts",
          "name": "syncAlerts",
          "description": "Whether to synchronize with alerts",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "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": [
            "case"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "In Progress",
              "value": "in-progress"
            },
            {
              "name": "Closed",
              "value": "closed"
            }
          ],
          "default": "open"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Sort",
      "name": "sortOptions",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Sort Options",
          "name": "sortOptionsProperties",
          "values": [
            {
              "displayName": "Sort Key",
              "name": "sortField",
              "type": "options",
              "options": [
                {
                  "name": "Created At",
                  "value": "createdAt"
                },
                {
                  "name": "Updated At",
                  "value": "updatedAt"
                }
              ],
              "default": "createdAt"
            },
            {
              "displayName": "Sort Order",
              "name": "sortOrder",
              "type": "options",
              "options": [
                {
                  "name": "Ascending",
                  "value": "asc"
                },
                {
                  "name": "Descending",
                  "value": "desc"
                }
              ],
              "default": "asc"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "open",
          "options": [
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "In Progress",
              "value": "in-progress"
            }
          ]
        },
        {
          "displayName": "Sync Alerts",
          "name": "syncAlerts",
          "description": "Whether to synchronize with alerts",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Version",
          "name": "version",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a comment to a case",
          "action": "Add a comment to a case"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a case comment",
          "action": "Get a case comment"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many case comments",
          "action": "Get many case comments"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a comment from a case",
          "action": "Remove a comment from a case"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a comment in a case",
          "action": "Update a comment from a case"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Comment",
      "name": "comment",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "description": "Valid application owner registered within the Cases Role Based Access Control system",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "description": "ID of the case comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "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": [
            "caseComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to remove",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Comment",
      "name": "comment",
      "type": "string",
      "default": "",
      "description": "Text to replace current comment message",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a tag to a case",
          "action": "Add a tag to a case"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a tag from a case",
          "action": "Remove a tag from a case"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "caseTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseTag"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tag",
      "type": "options",
      "default": "",
      "description": "Tag to attach to the case. 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": [
            "caseTag"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseTag"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tag",
      "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": [
            "caseTag"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a connector",
          "action": "Create a connector"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Connector Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Connectors allow you to send Elastic Security cases into other systems (only ServiceNow, Jira, or IBM Resilient)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Connector Type",
      "name": "connectorType",
      "type": "options",
      "default": ".jira",
      "options": [
        {
          "name": "IBM Resilient",
          "value": ".resilient"
        },
        {
          "name": "Jira",
          "value": ".jira"
        },
        {
          "name": "ServiceNow ITSM",
          "value": ".servicenow"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "API URL",
      "name": "apiUrl",
      "type": "string",
      "default": "",
      "description": "URL of the third-party instance",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Jira-registered email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "API Token",
      "name": "apiToken",
      "type": "string",
      "default": "",
      "description": "Jira API token",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Project Key",
      "name": "projectKey",
      "type": "string",
      "default": "",
      "description": "Jira Project Key",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "ServiceNow ITSM username",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "description": "ServiceNow ITSM password",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "API Key ID",
      "name": "apiKeyId",
      "type": "string",
      "default": "",
      "description": "IBM Resilient API key ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "API Key Secret",
      "name": "apiKeySecret",
      "type": "string",
      "default": "",
      "description": "IBM Resilient API key secret",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Organization ID",
      "name": "orgId",
      "type": "string",
      "default": "",
      "description": "IBM Resilient organization ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a case"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a case"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a case"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many cases"
    },
    {
      "operation": "getStatus",
      "name": "Get Status",
      "description": "Retrieve a summary of all case activity"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a case"
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Elastic Security node documentation
  description: Learn how to use the Elastic Security node in n8n. Follow technical documentation to integrate Elastic Security node into your workflows.
  contentType: [integration, reference]
  ---

  # Elastic Security node

  Use the Elastic Security node to automate work in Elastic Security, and integrate Elastic Security with other applications. n8n's has built-in support for a wide range of Elastic Security features, including creating, updating, deleting, retrieving, and getting cases.

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

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

  ## Operations

  * Case
      * Create a case
      * Delete a case
      * Get a case
      * Retrieve all cases
      * Retrieve a summary of all case activity
      * Update a case
  * Case Comment
      * Add a comment to a case
      * Get a case comment
      * Retrieve all case comments
      * Remove a comment from a case
      * Update a comment in a case
  * Case Tag
      * Add a tag to a case
      * Remove a tag from a case
  * Connector
      * Create a connector

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "case",
      "options": [
        {
          "name": "Case",
          "value": "case"
        },
        {
          "name": "Case Comment",
          "value": "caseComment"
        },
        {
          "name": "Case Tag",
          "value": "caseTag"
        },
        {
          "name": "Connector",
          "value": "connector"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a case",
          "action": "Create a case"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a case",
          "action": "Delete a case"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a case",
          "action": "Get a case"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many cases",
          "action": "Get many cases"
        },
        {
          "name": "Get Status",
          "value": "getStatus",
          "description": "Retrieve a summary of all case activity",
          "action": "Get the status of a case"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a case",
          "action": "Update a case"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Connector Name or ID",
      "name": "connectorId",
      "type": "options",
      "default": "",
      "description": "Connectors allow you to send Elastic Security cases into other systems (only ServiceNow, Jira, or IBM Resilient). 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": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getConnectors"
      }
    },
    {
      "displayName": "Connector Type",
      "name": "connectorType",
      "type": "options",
      "default": ".jira",
      "options": [
        {
          "name": "IBM Resilient",
          "value": ".resilient"
        },
        {
          "name": "Jira",
          "value": ".jira"
        },
        {
          "name": "ServiceNow ITSM",
          "value": ".servicenow"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Issue Type",
      "name": "issueType",
      "type": "string",
      "default": "",
      "description": "Type of the Jira issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "Priority",
      "name": "priority",
      "type": "string",
      "default": "",
      "description": "Priority of the Jira issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "Urgency",
      "name": "urgency",
      "type": "options",
      "default": 1,
      "description": "Urgency of the ServiceNow ITSM issue to create for this case",
      "options": [
        {
          "name": "Low",
          "value": 1
        },
        {
          "name": "Medium",
          "value": 2
        },
        {
          "name": "High",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Severity",
      "name": "severity",
      "type": "options",
      "default": 1,
      "description": "Severity of the ServiceNow ITSM issue to create for this case",
      "options": [
        {
          "name": "Low",
          "value": 1
        },
        {
          "name": "Medium",
          "value": 2
        },
        {
          "name": "High",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Impact",
      "name": "impact",
      "type": "options",
      "default": 1,
      "description": "Impact of the ServiceNow ITSM issue to create for this case",
      "options": [
        {
          "name": "Low",
          "value": 1
        },
        {
          "name": "Medium",
          "value": 2
        },
        {
          "name": "High",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Category",
      "name": "category",
      "type": "string",
      "default": "",
      "description": "Category of the ServiceNow ITSM issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Issue Types",
      "name": "issueTypes",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of numerical types of the IBM Resilient issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      }
    },
    {
      "displayName": "Severity Code",
      "name": "severityCode",
      "type": "number",
      "default": 1,
      "description": "Severity code of the IBM Resilient issue to create for this case",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "description": "Valid application owner registered within the Cases Role Based Access Control system",
          "default": ""
        },
        {
          "displayName": "Sync Alerts",
          "name": "syncAlerts",
          "description": "Whether to synchronize with alerts",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "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": [
            "case"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "In Progress",
              "value": "in-progress"
            },
            {
              "name": "Closed",
              "value": "closed"
            }
          ],
          "default": "open"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Sort",
      "name": "sortOptions",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Sort Options",
          "name": "sortOptionsProperties",
          "values": [
            {
              "displayName": "Sort Key",
              "name": "sortField",
              "type": "options",
              "options": [
                {
                  "name": "Created At",
                  "value": "createdAt"
                },
                {
                  "name": "Updated At",
                  "value": "updatedAt"
                }
              ],
              "default": "createdAt"
            },
            {
              "displayName": "Sort Order",
              "name": "sortOrder",
              "type": "options",
              "options": [
                {
                  "name": "Ascending",
                  "value": "asc"
                },
                {
                  "name": "Descending",
                  "value": "desc"
                }
              ],
              "default": "asc"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "open",
          "options": [
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "In Progress",
              "value": "in-progress"
            }
          ]
        },
        {
          "displayName": "Sync Alerts",
          "name": "syncAlerts",
          "description": "Whether to synchronize with alerts",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Version",
          "name": "version",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "case"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a comment to a case",
          "action": "Add a comment to a case"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a case comment",
          "action": "Get a case comment"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many case comments",
          "action": "Get many case comments"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a comment from a case",
          "action": "Remove a comment from a case"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a comment in a case",
          "action": "Update a comment from a case"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Comment",
      "name": "comment",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "description": "Valid application owner registered within the Cases Role Based Access Control system",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "description": "ID of the case comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "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": [
            "caseComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to remove",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "description": "ID of the case containing the comment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Comment",
      "name": "comment",
      "type": "string",
      "default": "",
      "description": "Text to replace current comment message",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "caseComment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a tag to a case",
          "action": "Add a tag to a case"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a tag from a case",
          "action": "Remove a tag from a case"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "caseTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseTag"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tag",
      "type": "options",
      "default": "",
      "description": "Tag to attach to the case. 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": [
            "caseTag"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Case ID",
      "name": "caseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "caseTag"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tag",
      "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": [
            "caseTag"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a connector",
          "action": "Create a connector"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Connector Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Connectors allow you to send Elastic Security cases into other systems (only ServiceNow, Jira, or IBM Resilient)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Connector Type",
      "name": "connectorType",
      "type": "options",
      "default": ".jira",
      "options": [
        {
          "name": "IBM Resilient",
          "value": ".resilient"
        },
        {
          "name": "Jira",
          "value": ".jira"
        },
        {
          "name": "ServiceNow ITSM",
          "value": ".servicenow"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "API URL",
      "name": "apiUrl",
      "type": "string",
      "default": "",
      "description": "URL of the third-party instance",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Jira-registered email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "API Token",
      "name": "apiToken",
      "type": "string",
      "default": "",
      "description": "Jira API token",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Project Key",
      "name": "projectKey",
      "type": "string",
      "default": "",
      "description": "Jira Project Key",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".jira"
          ]
        }
      }
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "ServiceNow ITSM username",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      }
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "description": "ServiceNow ITSM password",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".servicenow"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "API Key ID",
      "name": "apiKeyId",
      "type": "string",
      "default": "",
      "description": "IBM Resilient API key ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "API Key Secret",
      "name": "apiKeySecret",
      "type": "string",
      "default": "",
      "description": "IBM Resilient API key secret",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Organization ID",
      "name": "orgId",
      "type": "string",
      "default": "",
      "description": "IBM Resilient organization ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "connector"
          ],
          "operation": [
            "create"
          ],
          "connectorType": [
            ".resilient"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a case"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a case"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a case"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many cases"
    },
    {
      "operation": "getStatus",
      "name": "Get Status",
      "description": "Retrieve a summary of all case activity"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a case"
    }
  ]


node_type: nodes-base.emailReadImap
package_name: n8n-nodes-base
display_name: Email Trigger (IMAP)
description: Triggers the workflow when a new email is received
category: trigger
development_style: programmatic
version: 2.1
operations: []
credentials_required:
  [
  {
  "name": "imap",
  "required": true,
  "testedBy": "imapConnectionTest"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
properties_schema:
  [
    {
      "displayName": "Mailbox Name",
      "name": "mailbox",
      "type": "string",
      "default": "INBOX"
    },
    {
      "displayName": "Action",
      "name": "postProcessAction",
      "type": "options",
      "default": "read",
      "description": "What to do after the email has been received. If \"nothing\" gets selected it will be processed multiple times.",
      "options": [
        {
          "name": "Mark as Read",
          "value": "read"
        },
        {
          "name": "Nothing",
          "value": "nothing"
        }
      ]
    },
    {
      "displayName": "Download Attachments",
      "name": "downloadAttachments",
      "type": "boolean",
      "default": false,
      "description": "Whether attachments of emails should be downloaded. Only set if needed as it increases processing.",
      "displayOptions": {
        "show": {
          "format": [
            "simple"
          ]
        }
      }
    },
    {
      "displayName": "Format",
      "name": "format",
      "type": "options",
      "default": "simple",
      "description": "The format to return the message in",
      "options": [
        {
          "name": "RAW",
          "value": "raw",
          "description": "Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used"
        },
        {
          "name": "Resolved",
          "value": "resolved",
          "description": "Returns the full email with all data resolved and attachments saved as binary data"
        },
        {
          "name": "Simple",
          "value": "simple",
          "description": "Returns the full email; do not use if you wish to gather inline attachments"
        }
      ]
    },
    {
      "displayName": "Property Prefix Name",
      "name": "dataPropertyAttachmentsPrefixName",
      "type": "string",
      "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\"",
      "displayOptions": {
        "show": {
          "format": [
            "resolved"
          ]
        }
      }
    },
    {
      "displayName": "Property Prefix Name",
      "name": "dataPropertyAttachmentsPrefixName",
      "type": "string",
      "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\"",
      "displayOptions": {
        "show": {
          "format": [
            "simple"
          ],
          "downloadAttachments": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Email Rules",
          "name": "customEmailConfig",
          "type": "string",
          "default": "[\"UNSEEN\"]",
          "description": "Custom email fetching rules. See <a href=\"https://github.com/mscdex/node-imap\">node-imap</a>'s search function for more details."
        },
        {
          "displayName": "Force Reconnect Every Minutes",
          "name": "forceReconnect",
          "type": "number",
          "default": 60,
          "description": "Sets an interval (in minutes) to force a reconnection"
        },
        {
          "displayName": "Fetch Only New Emails",
          "name": "trackLastMessageId",
          "type": "boolean",
          "default": true,
          "description": "Whether to fetch only new emails since the last run, or all emails that match the \"Custom Email Rules\" ([\"UNSEEN\"] by default)",
          "displayOptions": {
            "show": {
              "@version": [
                {
                  "_cnd": {
                    "gte": 2.1
                  }
                }
              ]
            }
          }
        }
      ]
    }
  ]


node_type: nodes-base.emailSendTool
package_name: n8n-nodes-base
display_name: Send Email Tool
description: Sends an email using SMTP protocol (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 2.1
credentials_required:
  [
  {
  "name": "smtp",
  "required": true,
  "testedBy": "smtpConnectionTest"
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.emailSend
properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to send and manage emails"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "hidden",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "action": "Send an Email"
        },
        {
          "name": "Send and Wait for Response",
          "value": "sendAndWait",
          "action": "Send message and wait for response"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email Format",
      "name": "emailFormat",
      "type": "options",
      "default": "html",
      "options": [
        {
          "name": "Text",
          "value": "text",
          "description": "Send email as plain text"
        },
        {
          "name": "HTML",
          "value": "html",
          "description": "Send email as HTML"
        },
        {
          "name": "Both",
          "value": "both",
          "description": "Send both formats, recipient's client selects version to display"
        }
      ],
      "displayOptions": {
        "hide": {
          "@version": [
            2
          ]
        },
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email Format",
      "name": "emailFormat",
      "type": "options",
      "default": "text",
      "options": [
        {
          "name": "Text",
          "value": "text"
        },
        {
          "name": "HTML",
          "value": "html"
        },
        {
          "name": "Both",
          "value": "both"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "displayOptions": {
        "show": {
          "emailFormat": [
            "text",
            "both"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "emailFormat": [
            "html",
            "both"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase “This email was sent automatically with n8n” to the end of the email"
        },
        {
          "displayName": "Attachments",
          "name": "attachments",
          "type": "string",
          "default": "",
          "description": "Name of the binary properties that contain data to add to email as attachment. Multiple ones can be comma-separated. Reference embedded images or other content within the body of an email message, e.g. &lt;img src=\"cid:image_1\"&gt;"
        },
        {
          "displayName": "CC Email",
          "name": "ccEmail",
          "type": "string",
          "default": "",
          "placeholder": "cc@example.com",
          "description": "Email address of CC recipient"
        },
        {
          "displayName": "BCC Email",
          "name": "bccEmail",
          "type": "string",
          "default": "",
          "placeholder": "bcc@example.com",
          "description": "Email address of BCC recipient"
        },
        {
          "displayName": "Ignore SSL Issues (Insecure)",
          "name": "allowUnauthorizedCerts",
          "type": "boolean",
          "default": false,
          "description": "Whether to connect even if SSL certificate validation is not possible"
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "default": "",
          "placeholder": "info@example.com",
          "description": "The email address to send the reply to"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "rows": 4
      }
    },
    {
      "displayName": "Response Type",
      "name": "responseType",
      "type": "options",
      "default": "approval",
      "options": [
        {
          "name": "Approval",
          "value": "approval",
          "description": "User can approve/disapprove from within the message"
        },
        {
          "name": "Free Text",
          "value": "freeText",
          "description": "User can submit a response via a form"
        },
        {
          "name": "Custom Form",
          "value": "customForm",
          "description": "User can submit a response via a custom form"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Define Form",
      "name": "defineForm",
      "type": "options",
      "default": "fields",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "fields"
        },
        {
          "name": "Using JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Fields",
      "name": "jsonOutput",
      "type": "json",
      "default": "[\n  {\n    \"fieldLabel\": \"Name\",\n    \"placeholder\": \"enter your name\",\n    \"requiredField\": true\n  },\n  {\n    \"fieldLabel\": \"Age\",\n    \"fieldType\": \"number\",\n    \"placeholder\": \"enter your age\"\n  },\n  {\n    \"fieldLabel\": \"Email\",\n    \"fieldType\": \"email\",\n    \"requiredField\": true\n  },\n  {\n    \"fieldLabel\": \"Textarea\",\n    \"fieldType\": \"textarea\"\n  },\n  {\n    \"fieldLabel\": \"Dropdown Options\",\n    \"fieldType\": \"dropdown\",\n    \"fieldOptions\": {\n      \"values\": [\n        {\n          \"option\": \"option 1\"\n        },\n        {\n          \"option\": \"option 2\"\n        }\n      ]\n    },\n    \"requiredField\": true\n  },\n  {\n    \"fieldLabel\": \"Checkboxes\",\n    \"fieldType\": \"checkbox\",\n    \"fieldOptions\": {\n      \"values\": [\n        {\n          \"option\": \"option 1\"\n        },\n        {\n          \"option\": \"option 2\"\n        }\n      ]\n    }\n  },\n  {\n    \"fieldLabel\": \"Radio\",\n    \"fieldType\": \"radio\",\n    \"fieldOptions\": {\n      \"values\": [\n        {\n          \"option\": \"option 1\"\n        },\n        {\n          \"option\": \"option 2\"\n        }\n      ]\n    }\n  },\n  {\n    \"fieldLabel\": \"Email\",\n    \"fieldType\": \"email\",\n    \"placeholder\": \"me@mail.con\"\n  },\n  {\n    \"fieldLabel\": \"File\",\n    \"fieldType\": \"file\",\n    \"multipleFiles\": true,\n    \"acceptFileTypes\": \".jpg, .png\"\n  },\n  {\n    \"fieldLabel\": \"Number\",\n    \"fieldType\": \"number\"\n  },\n  {\n    \"fieldLabel\": \"Password\",\n    \"fieldType\": \"password\"\n  }\n]\n",
      "displayOptions": {
        "show": {
          "defineForm": [
            "json"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Form Elements",
      "name": "formFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "required": true,
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    2.4
                  ]
                }
              }
            },
            {
              "displayName": "Label",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Element Type",
              "name": "fieldType",
              "type": "options",
              "default": "text",
              "description": "The type of field to add to the form",
              "options": [
                {
                  "name": "Checkboxes",
                  "value": "checkbox"
                },
                {
                  "name": "Custom HTML",
                  "value": "html"
                },
                {
                  "name": "Date",
                  "value": "date"
                },
                {
                  "name": "Dropdown",
                  "value": "dropdown"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "File",
                  "value": "file"
                },
                {
                  "name": "Hidden Field",
                  "value": "hiddenField"
                },
                {
                  "name": "Number",
                  "value": "number"
                },
                {
                  "name": "Password",
                  "value": "password"
                },
                {
                  "name": "Radio Buttons",
                  "value": "radio"
                },
                {
                  "name": "Text Input",
                  "value": "text"
                },
                {
                  "name": "Textarea",
                  "value": "textarea"
                }
              ],
              "required": true
            },
            {
              "displayName": "Element Name",
              "name": "elementName",
              "type": "string",
              "default": "",
              "placeholder": "e.g. content-section",
              "description": "Optional field. It can be used to include the html in the output.",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Custom Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.5
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Placeholder",
              "name": "placeholder",
              "description": "Sample text to display inside the field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "dropdown",
                    "date",
                    "file",
                    "html",
                    "hiddenField",
                    "radio",
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-filled in the form field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "text",
                    "number",
                    "email",
                    "textarea"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default date value that will be pre-filled in the form field (format: YYYY-MM-DD)",
              "type": "dateTime",
              "typeOptions": {
                "dateOnly": true
              },
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-selected. Must match one of the option labels.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown",
                    "radio"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value(s) that will be pre-selected. Must match one or multiple of the option labels. Separate multiple pre-selected options with a comma.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "description": "Input value can be set here or will be passed as a query parameter via Field Name if no value is set",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Options",
              "name": "fieldOptions",
              "placeholder": "Add Field Option",
              "description": "List of options that can be selected from the dropdown",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Option",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Checkboxes",
              "name": "fieldOptions",
              "placeholder": "Add Checkbox",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Checkbox Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Radio Buttons",
              "name": "fieldOptions",
              "placeholder": "Add Radio Button",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "radio"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Radio Button Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Multiple Choice is a legacy option, please use Checkboxes or Radio Buttons field type instead",
              "name": "multiselectLegacyNotice",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "multiselect": [
                    true
                  ],
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Choice",
              "name": "multiselect",
              "type": "boolean",
              "default": false,
              "description": "Whether to allow the user to select multiple options from the dropdown list",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Limit Selection",
              "name": "limitSelection",
              "type": "options",
              "default": "unlimited",
              "options": [
                {
                  "name": "Exact Number",
                  "value": "exact"
                },
                {
                  "name": "Range",
                  "value": "range"
                },
                {
                  "name": "Unlimited",
                  "value": "unlimited"
                }
              ],
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Number of Selections",
              "name": "numberOfSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "exact"
                  ]
                }
              }
            },
            {
              "displayName": "Minimum Selections",
              "name": "minSelections",
              "type": "number",
              "default": 0,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 0,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "Maximum Selections",
              "name": "maxSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "HTML",
              "name": "html",
              "typeOptions": {
                "editor": "htmlEditor"
              },
              "type": "string",
              "noDataExpression": true,
              "default": "<!-- Your custom HTML here --->\n\n\n",
              "description": "HTML elements to display on the form page",
              "hint": "Does not accept <code>&lt;script&gt;</code>, <code>&lt;style&gt;</code> or <code>&lt;input&gt;</code> tags",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Files",
              "name": "multipleFiles",
              "type": "boolean",
              "default": true,
              "description": "Whether to allow the user to select multiple files from the file input or just one",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "Accepted File Types",
              "name": "acceptFileTypes",
              "type": "string",
              "default": "",
              "description": "Comma-separated list of allowed file extensions",
              "hint": "Leave empty to allow all file types",
              "placeholder": "e.g. .jpg, .png",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "The displayed date is formatted based on the locale of the user's browser",
              "name": "formatDate",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Required Field",
              "name": "requiredField",
              "type": "boolean",
              "default": false,
              "description": "Whether to require the user to enter a value for this field before submitting the form",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html",
                    "hiddenField"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "lt": 2.5
              }
            }
          ],
          "defineForm": [
            "fields"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.properties.find(p => p.name === \"fieldType\").options.find(o => o.value === $collection.item.value.fieldType).name }}"
        }
      }
    },
    {
      "displayName": "Form Elements",
      "name": "formFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "required": true,
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    2.4
                  ]
                }
              }
            },
            {
              "displayName": "Label",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Element Type",
              "name": "fieldType",
              "type": "options",
              "default": "text",
              "description": "The type of field to add to the form",
              "options": [
                {
                  "name": "Checkboxes",
                  "value": "checkbox"
                },
                {
                  "name": "Custom HTML",
                  "value": "html"
                },
                {
                  "name": "Date",
                  "value": "date"
                },
                {
                  "name": "Dropdown",
                  "value": "dropdown"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "File",
                  "value": "file"
                },
                {
                  "name": "Hidden Field",
                  "value": "hiddenField"
                },
                {
                  "name": "Number",
                  "value": "number"
                },
                {
                  "name": "Password",
                  "value": "password"
                },
                {
                  "name": "Radio Buttons",
                  "value": "radio"
                },
                {
                  "name": "Text Input",
                  "value": "text"
                },
                {
                  "name": "Textarea",
                  "value": "textarea"
                }
              ],
              "required": true
            },
            {
              "displayName": "Element Name",
              "name": "elementName",
              "type": "string",
              "default": "",
              "placeholder": "e.g. content-section",
              "description": "Optional field. It can be used to include the html in the output.",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Custom Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.5
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Placeholder",
              "name": "placeholder",
              "description": "Sample text to display inside the field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "dropdown",
                    "date",
                    "file",
                    "html",
                    "hiddenField",
                    "radio",
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-filled in the form field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "text",
                    "number",
                    "email",
                    "textarea"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default date value that will be pre-filled in the form field (format: YYYY-MM-DD)",
              "type": "dateTime",
              "typeOptions": {
                "dateOnly": true
              },
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-selected. Must match one of the option labels.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown",
                    "radio"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value(s) that will be pre-selected. Must match one or multiple of the option labels. Separate multiple pre-selected options with a comma.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "description": "Input value can be set here or will be passed as a query parameter via Field Name if no value is set",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Options",
              "name": "fieldOptions",
              "placeholder": "Add Field Option",
              "description": "List of options that can be selected from the dropdown",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Option",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Checkboxes",
              "name": "fieldOptions",
              "placeholder": "Add Checkbox",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Checkbox Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Radio Buttons",
              "name": "fieldOptions",
              "placeholder": "Add Radio Button",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "radio"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Radio Button Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Multiple Choice is a legacy option, please use Checkboxes or Radio Buttons field type instead",
              "name": "multiselectLegacyNotice",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "multiselect": [
                    true
                  ],
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Choice",
              "name": "multiselect",
              "type": "boolean",
              "default": false,
              "description": "Whether to allow the user to select multiple options from the dropdown list",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Limit Selection",
              "name": "limitSelection",
              "type": "options",
              "default": "unlimited",
              "options": [
                {
                  "name": "Exact Number",
                  "value": "exact"
                },
                {
                  "name": "Range",
                  "value": "range"
                },
                {
                  "name": "Unlimited",
                  "value": "unlimited"
                }
              ],
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Number of Selections",
              "name": "numberOfSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "exact"
                  ]
                }
              }
            },
            {
              "displayName": "Minimum Selections",
              "name": "minSelections",
              "type": "number",
              "default": 0,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 0,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "Maximum Selections",
              "name": "maxSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "HTML",
              "name": "html",
              "typeOptions": {
                "editor": "htmlEditor"
              },
              "type": "string",
              "noDataExpression": true,
              "default": "<!-- Your custom HTML here --->\n\n\n",
              "description": "HTML elements to display on the form page",
              "hint": "Does not accept <code>&lt;script&gt;</code>, <code>&lt;style&gt;</code> or <code>&lt;input&gt;</code> tags",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Files",
              "name": "multipleFiles",
              "type": "boolean",
              "default": true,
              "description": "Whether to allow the user to select multiple files from the file input or just one",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "Accepted File Types",
              "name": "acceptFileTypes",
              "type": "string",
              "default": "",
              "description": "Comma-separated list of allowed file extensions",
              "hint": "Leave empty to allow all file types",
              "placeholder": "e.g. .jpg, .png",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "The displayed date is formatted based on the locale of the user's browser",
              "name": "formatDate",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Required Field",
              "name": "requiredField",
              "type": "boolean",
              "default": false,
              "description": "Whether to require the user to enter a value for this field before submitting the form",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html",
                    "hiddenField"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "gte": 2.5
              }
            }
          ],
          "defineForm": [
            "fields"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true,
        "hideOptionalFields": true,
        "addOptionalFieldButtonText": "Add Attributes",
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.properties.find(p => p.name === \"fieldType\").options.find(o => o.value === $collection.item.value.fieldType).name }}"
        }
      }
    },
    {
      "displayName": "Approval Options",
      "name": "approvalOptions",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Type of Approval",
              "name": "approvalType",
              "type": "options",
              "placeholder": "Add option",
              "default": "single",
              "options": [
                {
                  "name": "Approve Only",
                  "value": "single"
                },
                {
                  "name": "Approve and Disapprove",
                  "value": "double"
                }
              ]
            },
            {
              "displayName": "Approve Button Label",
              "name": "approveLabel",
              "type": "string",
              "default": "Approve",
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "single",
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Approve Button Style",
              "name": "buttonApprovalStyle",
              "type": "options",
              "default": "primary",
              "options": [
                {
                  "name": "Primary",
                  "value": "primary"
                },
                {
                  "name": "Secondary",
                  "value": "secondary"
                }
              ],
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "single",
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Disapprove Button Label",
              "name": "disapproveLabel",
              "type": "string",
              "default": "Decline",
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Disapprove Button Style",
              "name": "buttonDisapprovalStyle",
              "type": "options",
              "default": "secondary",
              "options": [
                {
                  "name": "Primary",
                  "value": "primary"
                },
                {
                  "name": "Secondary",
                  "value": "secondary"
                }
              ],
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "double"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "approval"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Limit Wait Time",
          "name": "limitWaitTime",
          "type": "fixedCollection",
          "description": "Whether to limit the time this node should wait for a user response before execution resumes",
          "default": {
            "values": {
              "limitType": "afterTimeInterval",
              "resumeAmount": 45,
              "resumeUnit": "minutes"
            }
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Limit Type",
                  "name": "limitType",
                  "type": "options",
                  "default": "afterTimeInterval",
                  "description": "Sets the condition for the execution to resume. Can be a specified date or after some time.",
                  "options": [
                    {
                      "name": "After Time Interval",
                      "description": "Waits for a certain amount of time",
                      "value": "afterTimeInterval"
                    },
                    {
                      "name": "At Specified Time",
                      "description": "Waits until the set date and time to continue",
                      "value": "atSpecifiedTime"
                    }
                  ]
                },
                {
                  "displayName": "Amount",
                  "name": "resumeAmount",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "numberPrecision": 2
                  },
                  "default": 1,
                  "description": "The time to wait"
                },
                {
                  "displayName": "Unit",
                  "name": "resumeUnit",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Minutes",
                      "value": "minutes"
                    },
                    {
                      "name": "Hours",
                      "value": "hours"
                    },
                    {
                      "name": "Days",
                      "value": "days"
                    }
                  ],
                  "default": "hours",
                  "description": "Unit of the interval value"
                },
                {
                  "displayName": "Max Date and Time",
                  "name": "maxDateAndTime",
                  "type": "dateTime",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "atSpecifiedTime"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Continue execution after the specified date and time"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase \"This message was sent automatically with n8n\" to the end of the message"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "approval"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Message Button Label",
          "name": "messageButtonLabel",
          "type": "string",
          "default": "Respond"
        },
        {
          "displayName": "Response Form Title",
          "name": "responseFormTitle",
          "description": "Title of the form that the user can access to provide their response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Response Form Description",
          "name": "responseFormDescription",
          "description": "Description of the form that the user can access to provide their response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Response Form Button Label",
          "name": "responseFormButtonLabel",
          "type": "string",
          "default": "Submit"
        },
        {
          "displayName": "Response Form Custom Styling",
          "name": "responseFormCustomCss",
          "type": "string",
          "typeOptions": {
            "rows": 10,
            "editor": "cssEditor"
          },
          "default": ":root {\n\t--font-family: 'Open Sans', sans-serif;\n\t--font-weight-normal: 400;\n\t--font-weight-bold: 600;\n\t--font-size-body: 12px;\n\t--font-size-label: 14px;\n\t--font-size-test-notice: 12px;\n\t--font-size-input: 14px;\n\t--font-size-header: 20px;\n\t--font-size-paragraph: 14px;\n\t--font-size-link: 12px;\n\t--font-size-error: 12px;\n\t--font-size-html-h1: 28px;\n\t--font-size-html-h2: 20px;\n\t--font-size-html-h3: 16px;\n\t--font-size-html-h4: 14px;\n\t--font-size-html-h5: 12px;\n\t--font-size-html-h6: 10px;\n\t--font-size-subheader: 14px;\n\n\t/* Colors */\n\t--color-background: #fbfcfe;\n\t--color-test-notice-text: #e6a23d;\n\t--color-test-notice-bg: #fefaf6;\n\t--color-test-notice-border: #f6dcb7;\n\t--color-card-bg: #ffffff;\n\t--color-card-border: #dbdfe7;\n\t--color-card-shadow: rgba(99, 77, 255, 0.06);\n\t--color-link: #7e8186;\n\t--color-header: #525356;\n\t--color-label: #555555;\n\t--color-input-border: #dbdfe7;\n\t--color-input-text: #71747A;\n\t--color-focus-border: rgb(90, 76, 194);\n\t--color-submit-btn-bg: #ff6d5a;\n\t--color-submit-btn-text: #ffffff;\n\t--color-error: #ea1f30;\n\t--color-required: #ff6d5a;\n\t--color-clear-button-bg: #7e8186;\n\t--color-html-text: #555;\n\t--color-html-link: #ff6d5a;\n\t--color-header-subtext: #7e8186;\n\n\t/* Border Radii */\n\t--border-radius-card: 8px;\n\t--border-radius-input: 6px;\n\t--border-radius-clear-btn: 50%;\n\t--card-border-radius: 8px;\n\n\t/* Spacing */\n\t--padding-container-top: 24px;\n\t--padding-card: 24px;\n\t--padding-test-notice-vertical: 12px;\n\t--padding-test-notice-horizontal: 24px;\n\t--margin-bottom-card: 16px;\n\t--padding-form-input: 12px;\n\t--card-padding: 24px;\n\t--card-margin-bottom: 16px;\n\n\t/* Dimensions */\n\t--container-width: 448px;\n\t--submit-btn-height: 48px;\n\t--checkbox-size: 18px;\n\n\t/* Others */\n\t--box-shadow-card: 0px 4px 16px 0px var(--color-card-shadow);\n\t--opacity-placeholder: 0.5;\n}",
          "description": "Override default styling of the response form with CSS"
        },
        {
          "displayName": "Limit Wait Time",
          "name": "limitWaitTime",
          "type": "fixedCollection",
          "description": "Whether to limit the time this node should wait for a user response before execution resumes",
          "default": {
            "values": {
              "limitType": "afterTimeInterval",
              "resumeAmount": 45,
              "resumeUnit": "minutes"
            }
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Limit Type",
                  "name": "limitType",
                  "type": "options",
                  "default": "afterTimeInterval",
                  "description": "Sets the condition for the execution to resume. Can be a specified date or after some time.",
                  "options": [
                    {
                      "name": "After Time Interval",
                      "description": "Waits for a certain amount of time",
                      "value": "afterTimeInterval"
                    },
                    {
                      "name": "At Specified Time",
                      "description": "Waits until the set date and time to continue",
                      "value": "atSpecifiedTime"
                    }
                  ]
                },
                {
                  "displayName": "Amount",
                  "name": "resumeAmount",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "numberPrecision": 2
                  },
                  "default": 1,
                  "description": "The time to wait"
                },
                {
                  "displayName": "Unit",
                  "name": "resumeUnit",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Minutes",
                      "value": "minutes"
                    },
                    {
                      "name": "Hours",
                      "value": "hours"
                    },
                    {
                      "name": "Days",
                      "value": "days"
                    }
                  ],
                  "default": "hours",
                  "description": "Unit of the interval value"
                },
                {
                  "displayName": "Max Date and Time",
                  "name": "maxDateAndTime",
                  "type": "dateTime",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "atSpecifiedTime"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Continue execution after the specified date and time"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase \"This message was sent automatically with n8n\" to the end of the message"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "freeText",
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send"
    },
    {
      "operation": "sendAndWait",
      "name": "Send and Wait for Response"
    }
  ]


node_type: nodes-base.emailSend
package_name: n8n-nodes-base
display_name: Send Email
description: Sends an email using SMTP protocol
category: output
development_style: programmatic
version: 2.1
credentials_required:
  [
  {
  "name": "smtp",
  "required": true,
  "testedBy": "smtpConnectionTest"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-01-21 08:10:02
properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "hidden",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "action": "Send an Email"
        },
        {
          "name": "Send and Wait for Response",
          "value": "sendAndWait",
          "action": "Send message and wait for response"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email Format",
      "name": "emailFormat",
      "type": "options",
      "default": "html",
      "options": [
        {
          "name": "Text",
          "value": "text",
          "description": "Send email as plain text"
        },
        {
          "name": "HTML",
          "value": "html",
          "description": "Send email as HTML"
        },
        {
          "name": "Both",
          "value": "both",
          "description": "Send both formats, recipient's client selects version to display"
        }
      ],
      "displayOptions": {
        "hide": {
          "@version": [
            2
          ]
        },
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email Format",
      "name": "emailFormat",
      "type": "options",
      "default": "text",
      "options": [
        {
          "name": "Text",
          "value": "text"
        },
        {
          "name": "HTML",
          "value": "html"
        },
        {
          "name": "Both",
          "value": "both"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "displayOptions": {
        "show": {
          "emailFormat": [
            "text",
            "both"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "emailFormat": [
            "html",
            "both"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase “This email was sent automatically with n8n” to the end of the email"
        },
        {
          "displayName": "Attachments",
          "name": "attachments",
          "type": "string",
          "default": "",
          "description": "Name of the binary properties that contain data to add to email as attachment. Multiple ones can be comma-separated. Reference embedded images or other content within the body of an email message, e.g. &lt;img src=\"cid:image_1\"&gt;"
        },
        {
          "displayName": "CC Email",
          "name": "ccEmail",
          "type": "string",
          "default": "",
          "placeholder": "cc@example.com",
          "description": "Email address of CC recipient"
        },
        {
          "displayName": "BCC Email",
          "name": "bccEmail",
          "type": "string",
          "default": "",
          "placeholder": "bcc@example.com",
          "description": "Email address of BCC recipient"
        },
        {
          "displayName": "Ignore SSL Issues (Insecure)",
          "name": "allowUnauthorizedCerts",
          "type": "boolean",
          "default": false,
          "description": "Whether to connect even if SSL certificate validation is not possible"
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "default": "",
          "placeholder": "info@example.com",
          "description": "The email address to send the reply to"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. You can also specify a name: Nathan Doe &lt;nate@n8n.io&gt;.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "rows": 4
      }
    },
    {
      "displayName": "Response Type",
      "name": "responseType",
      "type": "options",
      "default": "approval",
      "options": [
        {
          "name": "Approval",
          "value": "approval",
          "description": "User can approve/disapprove from within the message"
        },
        {
          "name": "Free Text",
          "value": "freeText",
          "description": "User can submit a response via a form"
        },
        {
          "name": "Custom Form",
          "value": "customForm",
          "description": "User can submit a response via a custom form"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Define Form",
      "name": "defineForm",
      "type": "options",
      "default": "fields",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "fields"
        },
        {
          "name": "Using JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Fields",
      "name": "jsonOutput",
      "type": "json",
      "default": "[\n  {\n    \"fieldLabel\": \"Name\",\n    \"placeholder\": \"enter your name\",\n    \"requiredField\": true\n  },\n  {\n    \"fieldLabel\": \"Age\",\n    \"fieldType\": \"number\",\n    \"placeholder\": \"enter your age\"\n  },\n  {\n    \"fieldLabel\": \"Email\",\n    \"fieldType\": \"email\",\n    \"requiredField\": true\n  },\n  {\n    \"fieldLabel\": \"Textarea\",\n    \"fieldType\": \"textarea\"\n  },\n  {\n    \"fieldLabel\": \"Dropdown Options\",\n    \"fieldType\": \"dropdown\",\n    \"fieldOptions\": {\n      \"values\": [\n        {\n          \"option\": \"option 1\"\n        },\n        {\n          \"option\": \"option 2\"\n        }\n      ]\n    },\n    \"requiredField\": true\n  },\n  {\n    \"fieldLabel\": \"Checkboxes\",\n    \"fieldType\": \"checkbox\",\n    \"fieldOptions\": {\n      \"values\": [\n        {\n          \"option\": \"option 1\"\n        },\n        {\n          \"option\": \"option 2\"\n        }\n      ]\n    }\n  },\n  {\n    \"fieldLabel\": \"Radio\",\n    \"fieldType\": \"radio\",\n    \"fieldOptions\": {\n      \"values\": [\n        {\n          \"option\": \"option 1\"\n        },\n        {\n          \"option\": \"option 2\"\n        }\n      ]\n    }\n  },\n  {\n    \"fieldLabel\": \"Email\",\n    \"fieldType\": \"email\",\n    \"placeholder\": \"me@mail.con\"\n  },\n  {\n    \"fieldLabel\": \"File\",\n    \"fieldType\": \"file\",\n    \"multipleFiles\": true,\n    \"acceptFileTypes\": \".jpg, .png\"\n  },\n  {\n    \"fieldLabel\": \"Number\",\n    \"fieldType\": \"number\"\n  },\n  {\n    \"fieldLabel\": \"Password\",\n    \"fieldType\": \"password\"\n  }\n]\n",
      "displayOptions": {
        "show": {
          "defineForm": [
            "json"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Form Elements",
      "name": "formFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "required": true,
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    2.4
                  ]
                }
              }
            },
            {
              "displayName": "Label",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Element Type",
              "name": "fieldType",
              "type": "options",
              "default": "text",
              "description": "The type of field to add to the form",
              "options": [
                {
                  "name": "Checkboxes",
                  "value": "checkbox"
                },
                {
                  "name": "Custom HTML",
                  "value": "html"
                },
                {
                  "name": "Date",
                  "value": "date"
                },
                {
                  "name": "Dropdown",
                  "value": "dropdown"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "File",
                  "value": "file"
                },
                {
                  "name": "Hidden Field",
                  "value": "hiddenField"
                },
                {
                  "name": "Number",
                  "value": "number"
                },
                {
                  "name": "Password",
                  "value": "password"
                },
                {
                  "name": "Radio Buttons",
                  "value": "radio"
                },
                {
                  "name": "Text Input",
                  "value": "text"
                },
                {
                  "name": "Textarea",
                  "value": "textarea"
                }
              ],
              "required": true
            },
            {
              "displayName": "Element Name",
              "name": "elementName",
              "type": "string",
              "default": "",
              "placeholder": "e.g. content-section",
              "description": "Optional field. It can be used to include the html in the output.",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Custom Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.5
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Placeholder",
              "name": "placeholder",
              "description": "Sample text to display inside the field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "dropdown",
                    "date",
                    "file",
                    "html",
                    "hiddenField",
                    "radio",
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-filled in the form field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "text",
                    "number",
                    "email",
                    "textarea"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default date value that will be pre-filled in the form field (format: YYYY-MM-DD)",
              "type": "dateTime",
              "typeOptions": {
                "dateOnly": true
              },
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-selected. Must match one of the option labels.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown",
                    "radio"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value(s) that will be pre-selected. Must match one or multiple of the option labels. Separate multiple pre-selected options with a comma.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "description": "Input value can be set here or will be passed as a query parameter via Field Name if no value is set",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Options",
              "name": "fieldOptions",
              "placeholder": "Add Field Option",
              "description": "List of options that can be selected from the dropdown",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Option",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Checkboxes",
              "name": "fieldOptions",
              "placeholder": "Add Checkbox",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Checkbox Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Radio Buttons",
              "name": "fieldOptions",
              "placeholder": "Add Radio Button",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "radio"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Radio Button Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Multiple Choice is a legacy option, please use Checkboxes or Radio Buttons field type instead",
              "name": "multiselectLegacyNotice",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "multiselect": [
                    true
                  ],
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Choice",
              "name": "multiselect",
              "type": "boolean",
              "default": false,
              "description": "Whether to allow the user to select multiple options from the dropdown list",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Limit Selection",
              "name": "limitSelection",
              "type": "options",
              "default": "unlimited",
              "options": [
                {
                  "name": "Exact Number",
                  "value": "exact"
                },
                {
                  "name": "Range",
                  "value": "range"
                },
                {
                  "name": "Unlimited",
                  "value": "unlimited"
                }
              ],
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Number of Selections",
              "name": "numberOfSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "exact"
                  ]
                }
              }
            },
            {
              "displayName": "Minimum Selections",
              "name": "minSelections",
              "type": "number",
              "default": 0,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 0,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "Maximum Selections",
              "name": "maxSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "HTML",
              "name": "html",
              "typeOptions": {
                "editor": "htmlEditor"
              },
              "type": "string",
              "noDataExpression": true,
              "default": "<!-- Your custom HTML here --->\n\n\n",
              "description": "HTML elements to display on the form page",
              "hint": "Does not accept <code>&lt;script&gt;</code>, <code>&lt;style&gt;</code> or <code>&lt;input&gt;</code> tags",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Files",
              "name": "multipleFiles",
              "type": "boolean",
              "default": true,
              "description": "Whether to allow the user to select multiple files from the file input or just one",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "Accepted File Types",
              "name": "acceptFileTypes",
              "type": "string",
              "default": "",
              "description": "Comma-separated list of allowed file extensions",
              "hint": "Leave empty to allow all file types",
              "placeholder": "e.g. .jpg, .png",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "The displayed date is formatted based on the locale of the user's browser",
              "name": "formatDate",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Required Field",
              "name": "requiredField",
              "type": "boolean",
              "default": false,
              "description": "Whether to require the user to enter a value for this field before submitting the form",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html",
                    "hiddenField"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "lt": 2.5
              }
            }
          ],
          "defineForm": [
            "fields"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.properties.find(p => p.name === \"fieldType\").options.find(o => o.value === $collection.item.value.fieldType).name }}"
        }
      }
    },
    {
      "displayName": "Form Elements",
      "name": "formFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "required": true,
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    2.4
                  ]
                }
              }
            },
            {
              "displayName": "Label",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldLabel",
              "type": "string",
              "default": "",
              "placeholder": "e.g. What is your name?",
              "description": "Label that appears above the input field",
              "required": true,
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "hiddenField",
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.4
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Element Type",
              "name": "fieldType",
              "type": "options",
              "default": "text",
              "description": "The type of field to add to the form",
              "options": [
                {
                  "name": "Checkboxes",
                  "value": "checkbox"
                },
                {
                  "name": "Custom HTML",
                  "value": "html"
                },
                {
                  "name": "Date",
                  "value": "date"
                },
                {
                  "name": "Dropdown",
                  "value": "dropdown"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "File",
                  "value": "file"
                },
                {
                  "name": "Hidden Field",
                  "value": "hiddenField"
                },
                {
                  "name": "Number",
                  "value": "number"
                },
                {
                  "name": "Password",
                  "value": "password"
                },
                {
                  "name": "Radio Buttons",
                  "value": "radio"
                },
                {
                  "name": "Text Input",
                  "value": "text"
                },
                {
                  "name": "Textarea",
                  "value": "textarea"
                }
              ],
              "required": true
            },
            {
              "displayName": "Element Name",
              "name": "elementName",
              "type": "string",
              "default": "",
              "placeholder": "e.g. content-section",
              "description": "Optional field. It can be used to include the html in the output.",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Custom Field Name",
              "name": "fieldName",
              "description": "The name of the field, used in input attributes and referenced by the workflow",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html"
                  ]
                },
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.5
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Placeholder",
              "name": "placeholder",
              "description": "Sample text to display inside the field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "dropdown",
                    "date",
                    "file",
                    "html",
                    "hiddenField",
                    "radio",
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-filled in the form field",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "text",
                    "number",
                    "email",
                    "textarea"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default date value that will be pre-filled in the form field (format: YYYY-MM-DD)",
              "type": "dateTime",
              "typeOptions": {
                "dateOnly": true
              },
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value that will be pre-selected. Must match one of the option labels.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown",
                    "radio"
                  ]
                }
              }
            },
            {
              "displayName": "Default Value",
              "name": "defaultValue",
              "description": "Default value(s) that will be pre-selected. Must match one or multiple of the option labels. Separate multiple pre-selected options with a comma.",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "description": "Input value can be set here or will be passed as a query parameter via Field Name if no value is set",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "hiddenField"
                  ]
                }
              }
            },
            {
              "displayName": "Field Options",
              "name": "fieldOptions",
              "placeholder": "Add Field Option",
              "description": "List of options that can be selected from the dropdown",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Option",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Checkboxes",
              "name": "fieldOptions",
              "placeholder": "Add Checkbox",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Checkbox Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Radio Buttons",
              "name": "fieldOptions",
              "placeholder": "Add Radio Button",
              "type": "fixedCollection",
              "default": {
                "values": [
                  {
                    "option": ""
                  }
                ]
              },
              "required": true,
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "radio"
                  ]
                }
              },
              "typeOptions": {
                "multipleValues": true,
                "sortable": true
              },
              "options": [
                {
                  "displayName": "Values",
                  "name": "values",
                  "values": [
                    {
                      "displayName": "Radio Button Label",
                      "name": "option",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Multiple Choice is a legacy option, please use Checkboxes or Radio Buttons field type instead",
              "name": "multiselectLegacyNotice",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "multiselect": [
                    true
                  ],
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Choice",
              "name": "multiselect",
              "type": "boolean",
              "default": false,
              "description": "Whether to allow the user to select multiple options from the dropdown list",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "dropdown"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.3
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Limit Selection",
              "name": "limitSelection",
              "type": "options",
              "default": "unlimited",
              "options": [
                {
                  "name": "Exact Number",
                  "value": "exact"
                },
                {
                  "name": "Range",
                  "value": "range"
                },
                {
                  "name": "Unlimited",
                  "value": "unlimited"
                }
              ],
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ]
                }
              }
            },
            {
              "displayName": "Number of Selections",
              "name": "numberOfSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "exact"
                  ]
                }
              }
            },
            {
              "displayName": "Minimum Selections",
              "name": "minSelections",
              "type": "number",
              "default": 0,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 0,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "Maximum Selections",
              "name": "maxSelections",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "numberPrecision": 0,
                "minValue": 1,
                "showEvenWhenOptional": true
              },
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "checkbox"
                  ],
                  "limitSelection": [
                    "range"
                  ]
                }
              }
            },
            {
              "displayName": "HTML",
              "name": "html",
              "typeOptions": {
                "editor": "htmlEditor"
              },
              "type": "string",
              "noDataExpression": true,
              "default": "<!-- Your custom HTML here --->\n\n\n",
              "description": "HTML elements to display on the form page",
              "hint": "Does not accept <code>&lt;script&gt;</code>, <code>&lt;style&gt;</code> or <code>&lt;input&gt;</code> tags",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "html"
                  ]
                }
              }
            },
            {
              "displayName": "Multiple Files",
              "name": "multipleFiles",
              "type": "boolean",
              "default": true,
              "description": "Whether to allow the user to select multiple files from the file input or just one",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "Accepted File Types",
              "name": "acceptFileTypes",
              "type": "string",
              "default": "",
              "description": "Comma-separated list of allowed file extensions",
              "hint": "Leave empty to allow all file types",
              "placeholder": "e.g. .jpg, .png",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "The displayed date is formatted based on the locale of the user's browser",
              "name": "formatDate",
              "type": "notice",
              "default": "",
              "displayOptions": {
                "show": {
                  "fieldType": [
                    "date"
                  ]
                }
              }
            },
            {
              "displayName": "Required Field",
              "name": "requiredField",
              "type": "boolean",
              "default": false,
              "description": "Whether to require the user to enter a value for this field before submitting the form",
              "displayOptions": {
                "hide": {
                  "fieldType": [
                    "html",
                    "hiddenField"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "gte": 2.5
              }
            }
          ],
          "defineForm": [
            "fields"
          ],
          "responseType": [
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true,
        "hideOptionalFields": true,
        "addOptionalFieldButtonText": "Add Attributes",
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.properties.find(p => p.name === \"fieldType\").options.find(o => o.value === $collection.item.value.fieldType).name }}"
        }
      }
    },
    {
      "displayName": "Approval Options",
      "name": "approvalOptions",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Type of Approval",
              "name": "approvalType",
              "type": "options",
              "placeholder": "Add option",
              "default": "single",
              "options": [
                {
                  "name": "Approve Only",
                  "value": "single"
                },
                {
                  "name": "Approve and Disapprove",
                  "value": "double"
                }
              ]
            },
            {
              "displayName": "Approve Button Label",
              "name": "approveLabel",
              "type": "string",
              "default": "Approve",
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "single",
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Approve Button Style",
              "name": "buttonApprovalStyle",
              "type": "options",
              "default": "primary",
              "options": [
                {
                  "name": "Primary",
                  "value": "primary"
                },
                {
                  "name": "Secondary",
                  "value": "secondary"
                }
              ],
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "single",
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Disapprove Button Label",
              "name": "disapproveLabel",
              "type": "string",
              "default": "Decline",
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "double"
                  ]
                }
              }
            },
            {
              "displayName": "Disapprove Button Style",
              "name": "buttonDisapprovalStyle",
              "type": "options",
              "default": "secondary",
              "options": [
                {
                  "name": "Primary",
                  "value": "primary"
                },
                {
                  "name": "Secondary",
                  "value": "secondary"
                }
              ],
              "displayOptions": {
                "show": {
                  "approvalType": [
                    "double"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "approval"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Limit Wait Time",
          "name": "limitWaitTime",
          "type": "fixedCollection",
          "description": "Whether to limit the time this node should wait for a user response before execution resumes",
          "default": {
            "values": {
              "limitType": "afterTimeInterval",
              "resumeAmount": 45,
              "resumeUnit": "minutes"
            }
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Limit Type",
                  "name": "limitType",
                  "type": "options",
                  "default": "afterTimeInterval",
                  "description": "Sets the condition for the execution to resume. Can be a specified date or after some time.",
                  "options": [
                    {
                      "name": "After Time Interval",
                      "description": "Waits for a certain amount of time",
                      "value": "afterTimeInterval"
                    },
                    {
                      "name": "At Specified Time",
                      "description": "Waits until the set date and time to continue",
                      "value": "atSpecifiedTime"
                    }
                  ]
                },
                {
                  "displayName": "Amount",
                  "name": "resumeAmount",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "numberPrecision": 2
                  },
                  "default": 1,
                  "description": "The time to wait"
                },
                {
                  "displayName": "Unit",
                  "name": "resumeUnit",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Minutes",
                      "value": "minutes"
                    },
                    {
                      "name": "Hours",
                      "value": "hours"
                    },
                    {
                      "name": "Days",
                      "value": "days"
                    }
                  ],
                  "default": "hours",
                  "description": "Unit of the interval value"
                },
                {
                  "displayName": "Max Date and Time",
                  "name": "maxDateAndTime",
                  "type": "dateTime",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "atSpecifiedTime"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Continue execution after the specified date and time"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase \"This message was sent automatically with n8n\" to the end of the message"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "approval"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Message Button Label",
          "name": "messageButtonLabel",
          "type": "string",
          "default": "Respond"
        },
        {
          "displayName": "Response Form Title",
          "name": "responseFormTitle",
          "description": "Title of the form that the user can access to provide their response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Response Form Description",
          "name": "responseFormDescription",
          "description": "Description of the form that the user can access to provide their response",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Response Form Button Label",
          "name": "responseFormButtonLabel",
          "type": "string",
          "default": "Submit"
        },
        {
          "displayName": "Response Form Custom Styling",
          "name": "responseFormCustomCss",
          "type": "string",
          "typeOptions": {
            "rows": 10,
            "editor": "cssEditor"
          },
          "default": ":root {\n\t--font-family: 'Open Sans', sans-serif;\n\t--font-weight-normal: 400;\n\t--font-weight-bold: 600;\n\t--font-size-body: 12px;\n\t--font-size-label: 14px;\n\t--font-size-test-notice: 12px;\n\t--font-size-input: 14px;\n\t--font-size-header: 20px;\n\t--font-size-paragraph: 14px;\n\t--font-size-link: 12px;\n\t--font-size-error: 12px;\n\t--font-size-html-h1: 28px;\n\t--font-size-html-h2: 20px;\n\t--font-size-html-h3: 16px;\n\t--font-size-html-h4: 14px;\n\t--font-size-html-h5: 12px;\n\t--font-size-html-h6: 10px;\n\t--font-size-subheader: 14px;\n\n\t/* Colors */\n\t--color-background: #fbfcfe;\n\t--color-test-notice-text: #e6a23d;\n\t--color-test-notice-bg: #fefaf6;\n\t--color-test-notice-border: #f6dcb7;\n\t--color-card-bg: #ffffff;\n\t--color-card-border: #dbdfe7;\n\t--color-card-shadow: rgba(99, 77, 255, 0.06);\n\t--color-link: #7e8186;\n\t--color-header: #525356;\n\t--color-label: #555555;\n\t--color-input-border: #dbdfe7;\n\t--color-input-text: #71747A;\n\t--color-focus-border: rgb(90, 76, 194);\n\t--color-submit-btn-bg: #ff6d5a;\n\t--color-submit-btn-text: #ffffff;\n\t--color-error: #ea1f30;\n\t--color-required: #ff6d5a;\n\t--color-clear-button-bg: #7e8186;\n\t--color-html-text: #555;\n\t--color-html-link: #ff6d5a;\n\t--color-header-subtext: #7e8186;\n\n\t/* Border Radii */\n\t--border-radius-card: 8px;\n\t--border-radius-input: 6px;\n\t--border-radius-clear-btn: 50%;\n\t--card-border-radius: 8px;\n\n\t/* Spacing */\n\t--padding-container-top: 24px;\n\t--padding-card: 24px;\n\t--padding-test-notice-vertical: 12px;\n\t--padding-test-notice-horizontal: 24px;\n\t--margin-bottom-card: 16px;\n\t--padding-form-input: 12px;\n\t--card-padding: 24px;\n\t--card-margin-bottom: 16px;\n\n\t/* Dimensions */\n\t--container-width: 448px;\n\t--submit-btn-height: 48px;\n\t--checkbox-size: 18px;\n\n\t/* Others */\n\t--box-shadow-card: 0px 4px 16px 0px var(--color-card-shadow);\n\t--opacity-placeholder: 0.5;\n}",
          "description": "Override default styling of the response form with CSS"
        },
        {
          "displayName": "Limit Wait Time",
          "name": "limitWaitTime",
          "type": "fixedCollection",
          "description": "Whether to limit the time this node should wait for a user response before execution resumes",
          "default": {
            "values": {
              "limitType": "afterTimeInterval",
              "resumeAmount": 45,
              "resumeUnit": "minutes"
            }
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Limit Type",
                  "name": "limitType",
                  "type": "options",
                  "default": "afterTimeInterval",
                  "description": "Sets the condition for the execution to resume. Can be a specified date or after some time.",
                  "options": [
                    {
                      "name": "After Time Interval",
                      "description": "Waits for a certain amount of time",
                      "value": "afterTimeInterval"
                    },
                    {
                      "name": "At Specified Time",
                      "description": "Waits until the set date and time to continue",
                      "value": "atSpecifiedTime"
                    }
                  ]
                },
                {
                  "displayName": "Amount",
                  "name": "resumeAmount",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "numberPrecision": 2
                  },
                  "default": 1,
                  "description": "The time to wait"
                },
                {
                  "displayName": "Unit",
                  "name": "resumeUnit",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "afterTimeInterval"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Minutes",
                      "value": "minutes"
                    },
                    {
                      "name": "Hours",
                      "value": "hours"
                    },
                    {
                      "name": "Days",
                      "value": "days"
                    }
                  ],
                  "default": "hours",
                  "description": "Unit of the interval value"
                },
                {
                  "displayName": "Max Date and Time",
                  "name": "maxDateAndTime",
                  "type": "dateTime",
                  "displayOptions": {
                    "show": {
                      "limitType": [
                        "atSpecifiedTime"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Continue execution after the specified date and time"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Append n8n Attribution",
          "name": "appendAttribution",
          "type": "boolean",
          "default": true,
          "description": "Whether to include the phrase \"This message was sent automatically with n8n\" to the end of the message"
        }
      ],
      "displayOptions": {
        "show": {
          "responseType": [
            "freeText",
            "customForm"
          ],
          "resource": [
            "email"
          ],
          "operation": [
            "sendAndWait"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send"
    },
    {
      "operation": "sendAndWait",
      "name": "Send and Wait for Response"
    }
  ]


node_type: nodes-base.emeliaTool
package_name: n8n-nodes-base
display_name: Emelia Tool
description: Consume the Emelia API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "emeliaApi",
  "required": true,
  "testedBy": "emeliaApiTest"
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-21 08:10:02
tool_variant_of: nodes-base.emelia
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Emelia node documentation
  description: Learn how to use the Emelia node in n8n. Follow technical documentation to integrate Emelia node into your workflows.
  contentType: [integration, reference]
  ---

  # Emelia node

  Use the Emelia node to automate work in Emelia, and integrate Emelia with other applications. n8n has built-in support for a wide range of Emelia features, including creating campaigns, and adding contacts to a list. 

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

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

  ## Operations

  * Campaign
      * Add Contact
      * Create
      * Get
      * Get All
      * Pause
      * Start
  * Contact List
      * Add
      * Get All

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Emelia"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "campaign",
      "options": [
        {
          "name": "Campaign",
          "value": "campaign"
        },
        {
          "name": "Contact List",
          "value": "contactList"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Add Contact",
          "value": "addContact",
          "action": "Add a contact to a campaign"
        },
        {
          "name": "Create",
          "value": "create",
          "action": "Create a campaign"
        },
        {
          "name": "Duplicate",
          "value": "duplicate",
          "action": "Duplicate a campaign"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a campaign"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many campaigns"
        },
        {
          "name": "Pause",
          "value": "pause",
          "action": "Pause a campaign"
        },
        {
          "name": "Start",
          "value": "start",
          "action": "Start a campaign"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "type": "options",
      "default": [],
      "description": "The ID of the campaign to add the contact 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": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "addContact"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Contact Email",
      "name": "contactEmail",
      "type": "string",
      "default": "",
      "description": "The email of the contact to add to the campaign",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "addContact"
          ]
        }
      }
    },
    {
      "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",
                  "name": "fieldName",
                  "type": "string",
                  "default": "",
                  "description": "The name of the field to add custom field to"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the contact to add"
        },
        {
          "displayName": "Last Contacted",
          "name": "lastContacted",
          "type": "dateTime",
          "default": "",
          "description": "Last contacted date of the contact to add"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the contact to add"
        },
        {
          "displayName": "Last Open",
          "name": "lastOpen",
          "type": "dateTime",
          "default": "",
          "description": "Last opened date of the contact to add"
        },
        {
          "displayName": "Last Replied",
          "name": "lastReplied",
          "type": "dateTime",
          "default": "",
          "description": "Last replied date of the contact to add"
        },
        {
          "displayName": "Mails Sent",
          "name": "mailsSent",
          "type": "number",
          "default": 0,
          "description": "Number of emails sent to the contact to add"
        },
        {
          "displayName": "Phone Number",
          "name": "phoneNumber",
          "type": "string",
          "default": "",
          "description": "Phone number of the contact to add"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "addContact"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name",
      "name": "campaignName",
      "type": "string",
      "default": "",
      "description": "The name of the campaign to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Campaign ID",
      "name": "campaignId",
      "type": "string",
      "default": "",
      "description": "The ID of the campaign to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "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": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Campaign ID",
      "name": "campaignId",
      "type": "string",
      "default": "",
      "description": "The ID of the campaign to pause. The campaign must be in RUNNING mode.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "pause"
          ]
        }
      }
    },
    {
      "displayName": "Campaign ID",
      "name": "campaignId",
      "type": "string",
      "default": "",
      "description": "The ID of the campaign to start. Email provider and contacts must be set.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "start"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "type": "options",
      "default": "",
      "description": "The ID of the campaign to duplicate. 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": [
            "duplicate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "New Campaign Name",
      "name": "campaignName",
      "type": "string",
      "default": "",
      "description": "The name of the new campaign to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "duplicate"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Copy Contacts",
          "name": "copyContacts",
          "type": "boolean",
          "default": false,
          "description": "Whether to copy all the contacts from the original campaign"
        },
        {
          "displayName": "Copy Email Provider",
          "name": "copyProvider",
          "type": "boolean",
          "default": true,
          "description": "Whether to set the same email provider than the original campaign"
        },
        {
          "displayName": "Copy Email Sequence",
          "name": "copyMails",
          "type": "boolean",
          "default": true,
          "description": "Whether to copy all the steps of the email sequence from the original campaign"
        },
        {
          "displayName": "Copy Global Settings",
          "name": "copySettings",
          "type": "boolean",
          "default": true,
          "description": "Whether to copy all the general settings from the original campaign"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "duplicate"
          ],
          "resource": [
            "campaign"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a contact list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many contact lists"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact List Name or ID",
      "name": "contactListId",
      "type": "options",
      "default": [],
      "description": "The ID of the contact list to add the contact 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": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContactLists"
      }
    },
    {
      "displayName": "Contact Email",
      "name": "contactEmail",
      "type": "string",
      "default": "",
      "description": "The email of the contact to add to the contact list",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "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",
                  "name": "fieldName",
                  "type": "string",
                  "default": "",
                  "description": "The name of the field to add custom field to"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the contact to add"
        },
        {
          "displayName": "Last Contacted",
          "name": "lastContacted",
          "type": "dateTime",
          "default": "",
          "description": "Last contacted date of the contact to add"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the contact to add"
        },
        {
          "displayName": "Last Open",
          "name": "lastOpen",
          "type": "dateTime",
          "default": "",
          "description": "Last opened date of the contact to add"
        },
        {
          "displayName": "Last Replied",
          "name": "lastReplied",
          "type": "dateTime",
          "default": "",
          "description": "Last replied date of the contact to add"
        },
        {
          "displayName": "Mails Sent",
          "name": "mailsSent",
          "type": "number",
          "default": 0,
          "description": "Number of emails sent to the contact to add"
        },
        {
          "displayName": "Phone Number",
          "name": "phoneNumber",
          "type": "string",
          "default": "",
          "description": "Phone number of the contact to add"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "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": [
            "contactList"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    }
  ]

operations:
  [
    {
      "operation": "addContact",
      "name": "Add Contact"
    },
    {
      "operation": "create",
      "name": "Create"
    },
    {
      "operation": "duplicate",
      "name": "Duplicate"
    },
    {
      "operation": "get",
      "name": "Get"
    },
    {
      "operation": "getAll",
      "name": "Get Many"
    },
    {
      "operation": "pause",
      "name": "Pause"
    },
    {
      "operation": "start",
      "name": "Start"
    }
  ]


