# nodes

node_type: nodes-base.aiTransform
package_name: n8n-nodes-base
display_name: AI Transform
description: Modify data based on instructions written in plain english
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AI Transform
  description: Documentation for the AI Transform node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  ---

  # AI Transform

  Use the AI Transform node to generate code snippets based on your prompt. The AI is context-aware, understanding the workflow’s nodes and their data types.

  /// info | Feature availability
  Available only on [Cloud plans](/manage-cloud/overview.md).
  ///

  ## Node parameters

  ### Instructions

  Enter your prompt for the AI and click the **Generate code** button to automatically populate the **Transformation Code**. For example, you can specify how you want to process or categorize your data. Refer to [Writing good prompts](/code/ai-code.md#writing-good-prompts) for more information. 

  The prompt should be in plain English and under 500 characters. 

  ### Transformation Code

  The code snippet generated by the node is read-only. To edit this code, adjust your prompt in **Instructions** or copy and paste it into a [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node. 

  ## Templates and examples

  [[ templatesWidget(page.title, 'ai-transform') ]]

properties_schema:
  [
    {
      "displayName": "Instructions",
      "name": "instructions",
      "type": "button",
      "default": "",
      "description": "Provide instructions on how you want to transform the data, then click 'Generate code'. Use dot notation to refer to nested fields (e.g. address.street).",
      "typeOptions": {
        "buttonConfig": {
          "label": "Generate code",
          "hasInputField": true,
          "inputFieldMaxLength": 500,
          "action": {
            "type": "askAiCodeGeneration",
            "target": "jsCode"
          }
        }
      }
    },
    {
      "displayName": "Code Generated For Prompt",
      "name": "codeGeneratedForPrompt",
      "type": "hidden",
      "default": ""
    },
    {
      "displayName": "Generated JavaScript",
      "name": "jsCode",
      "type": "string",
      "default": "",
      "typeOptions": {
        "editor": "jsEditor",
        "editorIsReadOnly": true
      },
      "noDataExpression": true
    }
  ]


node_type: nodes-base.amqp
package_name: n8n-nodes-base
display_name: AMQP Sender
description: Sends a raw-message via AMQP 1.0, executed once per item
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "amqp",
  "required": true,
  "testedBy": "amqpConnectionTest"
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AMQP Sender node documentation
  description: Learn how to use the AMQP Sender node in n8n. Follow technical documentation to integrate AMQP Sender node into your workflows.
  contentType: [integration, reference]
  ---

  # AMQP Sender node

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

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

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

  ## Operations

  - Send message

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Queue / Topic",
      "name": "sink",
      "type": "string",
      "default": "",
      "description": "Name of the queue of topic to publish to"
    },
    {
      "displayName": "Headers",
      "name": "headerParametersJson",
      "type": "json",
      "default": "",
      "description": "Header parameters as JSON (flat object). Sent as application_properties in amqp-message meta info."
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Container ID",
          "name": "containerId",
          "type": "string",
          "default": "",
          "description": "Will be used to pass to the RHEA Backend as container_id"
        },
        {
          "displayName": "Data as Object",
          "name": "dataAsObject",
          "type": "boolean",
          "default": false,
          "description": "Whether to send the data as an object"
        },
        {
          "displayName": "Reconnect",
          "name": "reconnect",
          "type": "boolean",
          "default": true,
          "description": "Whether to automatically reconnect if disconnected"
        },
        {
          "displayName": "Reconnect Limit",
          "name": "reconnectLimit",
          "type": "number",
          "default": 50,
          "description": "Maximum number of reconnect attempts"
        },
        {
          "displayName": "Send Property",
          "name": "sendOnlyProperty",
          "type": "string",
          "default": "",
          "description": "The only property to send. If empty the whole item will be sent."
        }
      ]
    }
  ]


node_type: nodes-base.amqpTrigger
package_name: n8n-nodes-base
display_name: AMQP Trigger
description: Listens to AMQP 1.0 Messages
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "amqp",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AMQP Trigger node documentation
  description: Learn how to use the AMQP Trigger node in n8n. Follow technical documentation to integrate AMQP Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # AMQP Trigger node

  [AMQP](https://www.amqp.org/){:target=_blank .external-link} is an open standard application layer protocol for message-oriented middleware. The defining features of AMQP are message orientation, queuing, routing, reliability and security. This node supports AMQP 1.0 compatible message brokers.

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

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

properties_schema:
  [
    {
      "displayName": "Queue / Topic",
      "name": "sink",
      "type": "string",
      "default": "",
      "description": "Name of the queue of topic to listen to"
    },
    {
      "displayName": "Clientname",
      "name": "clientname",
      "type": "string",
      "default": "",
      "description": "Leave empty for non-durable topic subscriptions or queues"
    },
    {
      "displayName": "Subscription",
      "name": "subscription",
      "type": "string",
      "default": "",
      "description": "Leave empty for non-durable topic subscriptions or queues"
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Container ID",
          "name": "containerId",
          "type": "string",
          "default": "",
          "description": "Will be used to pass to the RHEA Backend as container_id"
        },
        {
          "displayName": "Convert Body To String",
          "name": "jsonConvertByteArrayToString",
          "type": "boolean",
          "default": false,
          "description": "Whether to convert JSON Body content ([\"body\"][\"content\"]) from Byte Array to string. Needed for Azure Service Bus."
        },
        {
          "displayName": "JSON Parse Body",
          "name": "jsonParseBody",
          "type": "boolean",
          "default": false,
          "description": "Whether to parse the body to an object"
        },
        {
          "displayName": "Messages per Cicle",
          "name": "pullMessagesNumber",
          "type": "number",
          "default": 100,
          "description": "Number of messages to pull from the bus for every cicle"
        },
        {
          "displayName": "Only Body",
          "name": "onlyBody",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only the body property"
        },
        {
          "displayName": "Parallel Processing",
          "name": "parallelProcessing",
          "type": "boolean",
          "default": true,
          "description": "Whether to process messages in parallel"
        },
        {
          "displayName": "Reconnect",
          "name": "reconnect",
          "type": "boolean",
          "default": true,
          "description": "Whether to automatically reconnect if disconnected"
        },
        {
          "displayName": "Reconnect Limit",
          "name": "reconnectLimit",
          "type": "number",
          "default": 50,
          "description": "Maximum number of reconnect attempts"
        },
        {
          "displayName": "Sleep Time",
          "name": "sleepTime",
          "type": "number",
          "default": 10,
          "description": "Milliseconds to sleep after every cicle"
        }
      ]
    }
  ]


node_type: nodes-base.apiTemplateIo
package_name: n8n-nodes-base
display_name: APITemplate.io
description: Consume the APITemplate.io API
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "create",
  "name": "Create"
  }
  ]

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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: APITemplate.io node documentation
  description: Learn how to use the APITemplate.io node in n8n. Follow technical documentation to integrate APITemplate.io node into your workflows.
  contentType: [integration, reference]
  ---

  # APITemplate.io node

  Use the APITemplate.io node to automate work in APITemplate.io, and integrate APITemplate.io with other applications. n8n has built-in support for a wide range of APITemplate.io features, including getting and creating accounts and PDF.

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

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

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

  ## Operations

  * Account
      * Get
  * Image
      * Create
  * PDF
      * Create

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "image",
      "options": [
        {
          "name": "Account",
          "value": "account"
        },
        {
          "name": "Image",
          "value": "image"
        },
        {
          "name": "PDF",
          "value": "pdf"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an image"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a pdf"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "pdf"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an account"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template Name or ID",
      "name": "imageTemplateId",
      "type": "options",
      "default": "",
      "description": "ID of the image template to use. 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": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getImageTemplates"
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "pdfTemplateId",
      "type": "options",
      "default": "",
      "description": "ID of the PDF template to use. 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": [
            "pdf"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPdfTemplates"
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "pdf",
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Download",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Name of the binary property to which to write the data of the read file",
      "displayOptions": {
        "show": {
          "resource": [
            "pdf",
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryProperty",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "pdf",
            "image"
          ],
          "operation": [
            "create"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Overrides (JSON)",
      "name": "overridesJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Properties (JSON)",
      "name": "propertiesJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "pdf"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Overrides",
      "name": "overridesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "overrideValues",
          "displayName": "Override",
          "values": [
            {
              "displayName": "Properties",
              "name": "propertiesUi",
              "placeholder": "Add Property",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "propertyValues",
                  "displayName": "Property",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the property"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to the property"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Properties",
      "name": "propertiesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertyValues",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Name of the property"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to the property"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "pdf"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "The name of the downloaded image/pdf. It has to include the extension. For example: report.pdf"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "pdf",
            "image"
          ],
          "download": [
            true
          ]
        }
      }
    }
  ]


node_type: nodes-base.asana
package_name: n8n-nodes-base
display_name: Asana
description: Consume Asana REST API
category: input
development_style: programmatic
version: 1
updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Asana node documentation
  description: Learn how to use the Asana node in n8n. Follow technical documentation to integrate Asana node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Asana node

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

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

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

  /// note | Update to 1.22.2 or above
  Due to changes in Asana's API, some operations in this node stopped working on 17th January 2023. Upgrade to n8n 1.22.2 or above.
  ///

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

  ## Operations

  * Project
      * Create a new project
      * Delete a project
      * Get a project
      * Get all projects
      * Update a project
  * Subtask
      * Create a subtask
      * Get all subtasks
  * Task
      * Create a task
      * Delete a task
      * Get a task
      * Get all tasks
      * Move a task
      * Search for tasks
      * Update a task
  * Task Comment
      * Add a comment to a task
      * Remove a comment from a task
  * Task Tag
      * Add a tag to a task
      * Remove a tag from a task
  * Task Project
      * Add a task to a project
      * Remove a task from a project
  * User
      * Get a user
      * Get all users

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "task",
      "options": [
        {
          "name": "Project",
          "value": "project"
        },
        {
          "name": "Subtask",
          "value": "subtask"
        },
        {
          "name": "Task",
          "value": "task"
        },
        {
          "name": "Task Comment",
          "value": "taskComment"
        },
        {
          "name": "Task Project",
          "value": "taskProject"
        },
        {
          "name": "Task Tag",
          "value": "taskTag"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a subtask",
          "action": "Create a subtask"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many subtasks",
          "action": "Get many subtasks"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subtask"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Parent Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "The task to operate on",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "subtask"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the subtask to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "subtask"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "otherProperties",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assignee",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "Set Assignee on the subtask. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Assignee Status",
          "name": "assignee_status",
          "type": "options",
          "options": [
            {
              "name": "Inbox",
              "value": "inbox"
            },
            {
              "name": "Today",
              "value": "today"
            },
            {
              "name": "Upcoming",
              "value": "upcoming"
            },
            {
              "name": "Later",
              "value": "later"
            }
          ],
          "default": "inbox",
          "description": "Set Assignee status on the subtask (requires Assignee)"
        },
        {
          "displayName": "Completed",
          "name": "completed",
          "type": "boolean",
          "default": false,
          "description": "Whether the subtask should be marked completed"
        },
        {
          "displayName": "Due On",
          "name": "due_on",
          "type": "dateTime",
          "default": "",
          "description": "Date on which the time is due"
        },
        {
          "displayName": "Liked",
          "name": "liked",
          "type": "boolean",
          "default": false,
          "description": "Whether the task is liked by the authorized user"
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "typeOptions": {
            "rows": 5
          },
          "default": "",
          "description": "The task notes"
        },
        {
          "displayName": "Workspace Name or ID",
          "name": "workspace",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getWorkspaces"
          },
          "default": "",
          "description": "The workspace to create the subtask in. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subtask"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Parent Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "The task to operate on",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "subtask"
          ]
        }
      }
    },
    {
      "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": [
            "subtask"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "subtask"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Field Names or IDs",
          "name": "opt_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTaskFields"
          },
          "default": [
            "gid",
            "name",
            "resource_type"
          ],
          "description": "Defines fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Pretty",
          "name": "opt_pretty",
          "type": "boolean",
          "default": false,
          "description": "Whether to provide “pretty” output"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "subtask"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a task",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a task",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tasks",
          "action": "Get many tasks"
        },
        {
          "name": "Move",
          "value": "move",
          "description": "Move a task",
          "action": "Move a task"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search for tasks",
          "action": "Search a task"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a task",
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace to create the task in. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the task to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to get the data of",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "description": "Properties to search for",
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assignee",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "The assignee to filter tasks on. Note: If you specify assignee, you must also specify the workspace to filter on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Field Names or IDs",
          "name": "opt_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTaskFields"
          },
          "default": [
            "gid",
            "name",
            "resource_type"
          ],
          "description": "Defines fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Pretty",
          "name": "opt_pretty",
          "type": "boolean",
          "default": false,
          "description": "Whether to provide “pretty” output"
        },
        {
          "displayName": "Project Name or ID",
          "name": "project",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getProjects"
          },
          "default": "",
          "description": "The project to filter tasks on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Section Name or ID",
          "name": "section",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getSections"
          },
          "default": "",
          "description": "The section to filter tasks on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Workspace Name or ID",
          "name": "workspace",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getWorkspaces"
          },
          "default": "",
          "description": "The workspace to filter tasks on. Note: If you specify workspace, you must also specify the assignee to filter on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Completed Since",
          "name": "completed_since",
          "type": "dateTime",
          "default": "",
          "description": "Only return tasks that are either incomplete or that have been completed since this time"
        },
        {
          "displayName": "Modified Since",
          "name": "modified_since",
          "type": "dateTime",
          "default": "",
          "description": "Only return tasks that have been modified since the given time"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to be moved",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "move"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "Project to show the sections of. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "move"
          ],
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Section Name or ID",
      "name": "section",
      "type": "options",
      "default": "",
      "description": "The Section to move the task to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "move"
          ],
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "projectId"
        ],
        "loadOptionsMethod": "getSections"
      }
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to update the data of",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace in which the task is searched. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Filters",
      "name": "searchTaskProperties",
      "type": "collection",
      "default": {},
      "description": "Properties to search for",
      "options": [
        {
          "displayName": "Completed",
          "name": "completed",
          "type": "boolean",
          "default": false,
          "description": "Whether the task is marked completed"
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "typeOptions": {
            "rows": 5
          },
          "default": "",
          "description": "Text to search for in name or notes"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "otherProperties",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assignee",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "Set Assignee on the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Assignee Status",
          "name": "assignee_status",
          "type": "options",
          "options": [
            {
              "name": "Inbox",
              "value": "inbox"
            },
            {
              "name": "Today",
              "value": "today"
            },
            {
              "name": "Upcoming",
              "value": "upcoming"
            },
            {
              "name": "Later",
              "value": "later"
            }
          ],
          "default": "inbox",
          "description": "Set Assignee status on the task (requires Assignee)"
        },
        {
          "displayName": "Completed",
          "name": "completed",
          "type": "boolean",
          "default": false,
          "description": "Whether the task should be marked completed"
        },
        {
          "displayName": "Due On",
          "name": "due_on",
          "type": "dateTime",
          "default": "",
          "description": "Date on which the time is due"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ]
            }
          },
          "description": "The new name of the task"
        },
        {
          "displayName": "Liked",
          "name": "liked",
          "type": "boolean",
          "default": false,
          "description": "Whether the task is liked by the authorized user"
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "typeOptions": {
            "rows": 5
          },
          "default": "",
          "description": "The task notes"
        },
        {
          "displayName": "Project Names or IDs",
          "name": "projects",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getProjects"
          },
          "default": [],
          "description": "The project to filter tasks on. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a comment to a task",
          "action": "Add a task comment"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a comment from a task",
          "action": "Remove a task comment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "taskComment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to add the comment to",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskComment"
          ]
        }
      }
    },
    {
      "displayName": "Is Text HTML",
      "name": "isTextHtml",
      "type": "boolean",
      "default": false,
      "description": "Whether body is HTML or simple text",
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskComment"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The plain text of the comment to add",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskComment"
          ],
          "isTextHtml": [
            false
          ]
        }
      }
    },
    {
      "displayName": "HTML Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Comment as HTML string. Do not use together with plain text.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskComment"
          ],
          "isTextHtml": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Properties of the task comment",
      "options": [
        {
          "displayName": "Pinned",
          "name": "is_pinned",
          "type": "boolean",
          "default": false,
          "description": "Whether to pin the comment"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskComment"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the comment to be removed",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "remove"
          ],
          "resource": [
            "taskComment"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a task to a project",
          "action": "Add a task project"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a task from a project",
          "action": "Remove a task project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "taskProject"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to add the project to",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskProject"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "project",
      "type": "options",
      "default": "",
      "description": "The project where the task will be added. 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": [
            "add"
          ],
          "resource": [
            "taskProject"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Other properties to set",
      "options": [
        {
          "displayName": "Insert After",
          "name": "insert_after",
          "type": "string",
          "default": "",
          "description": "A task in the project to insert the task after, or null to insert at the beginning of the list"
        },
        {
          "displayName": "Insert Before",
          "name": "insert_before",
          "type": "string",
          "default": "",
          "description": "A task in the project to insert the task before, or null to insert at the end of the list"
        },
        {
          "displayName": "Section",
          "name": "section",
          "type": "string",
          "default": "",
          "description": "A section in the project to insert the task into. The task will be inserted at the bottom of the section."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "taskProject"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to add the project to",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "remove"
          ],
          "resource": [
            "taskProject"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "project",
      "type": "options",
      "default": "",
      "description": "The project where the task will be removed from. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "remove"
          ],
          "resource": [
            "taskProject"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a tag to a task",
          "action": "Add a task tag"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a tag from a task",
          "action": "Remove a task tag"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "taskTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to add the tag to",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "taskTag"
          ]
        }
      }
    },
    {
      "displayName": "Tags Name or ID",
      "name": "tag",
      "type": "options",
      "default": "",
      "description": "The tag that should be added. 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": [
            "add"
          ],
          "resource": [
            "taskTag"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "id"
        ],
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Task ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task to add the tag to",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "remove"
          ],
          "resource": [
            "taskTag"
          ]
        }
      }
    },
    {
      "displayName": "Tags Name or ID",
      "name": "tag",
      "type": "options",
      "default": "",
      "description": "The tag that should be added. 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": [
            "remove"
          ],
          "resource": [
            "taskTag"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "id"
        ],
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a user",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many users",
          "action": "Get many users"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "An identifier for the user to get data of. Can be one of an email address,the globally unique identifier for the user, or the keyword me to indicate the current user making the request.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace in which to get users. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "user"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new project",
          "action": "Create a project"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a project",
          "action": "Delete a project"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a project",
          "action": "Get a project"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many projects",
          "action": "Get many projects"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a project",
          "action": "Update a project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the project to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace to create the project in. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "project"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "team",
      "type": "options",
      "default": "",
      "description": "The team this project will be assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "project"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "workspace"
        ],
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Other properties to set",
      "options": [
        {
          "displayName": "Color",
          "name": "color",
          "type": "options",
          "options": [
            {
              "name": "dark-blue",
              "value": "dark-blue"
            },
            {
              "name": "dark-brown",
              "value": "dark-brown"
            },
            {
              "name": "dark-green",
              "value": "dark-green"
            },
            {
              "name": "dark-orange",
              "value": "dark-orange"
            },
            {
              "name": "dark-pink",
              "value": "dark-pink"
            },
            {
              "name": "dark-purple",
              "value": "dark-purple"
            },
            {
              "name": "dark-red",
              "value": "dark-red"
            },
            {
              "name": "dark-teal",
              "value": "dark-teal"
            },
            {
              "name": "dark-warm-gray",
              "value": "dark-warm-gray"
            },
            {
              "name": "light-blue",
              "value": "light-blue"
            },
            {
              "name": "light-green",
              "value": "light-green"
            },
            {
              "name": "light-orange",
              "value": "light-orange"
            },
            {
              "name": "light-pink",
              "value": "light-pink"
            },
            {
              "name": "light-purple",
              "value": "light-purple"
            },
            {
              "name": "light-red",
              "value": "light-red"
            },
            {
              "name": "light-teal",
              "value": "light-teal"
            },
            {
              "name": "light-warm-gray",
              "value": "light-warm-gray"
            },
            {
              "name": "light-yellow",
              "value": "light-yellow"
            },
            {
              "name": "none",
              "value": "none"
            }
          ],
          "default": "none",
          "description": "Color of the project"
        },
        {
          "displayName": "Due On",
          "name": "due_on",
          "type": "dateTime",
          "default": "",
          "description": "The day on which this project is due. This takes a date with format YYYY-MM-DD."
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": "",
          "description": "Basic description or notes for the project"
        },
        {
          "displayName": "Privacy Setting",
          "name": "privacy_setting",
          "type": "options",
          "options": [
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Private to Team",
              "value": "private_to_team"
            },
            {
              "name": "Public to Workspace",
              "value": "public_to_workspace"
            }
          ],
          "default": "private",
          "description": "The privacy setting of the project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace in which to get users. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "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": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Other properties to set",
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": false,
          "description": "Whether to only return projects whose archived field takes on the value of this parameter"
        },
        {
          "displayName": "Teams Name or ID",
          "name": "team",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspace"
            ],
            "loadOptionsMethod": "getTeams"
          },
          "default": "",
          "description": "The new name of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace in which to get users. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "project"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Project ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the project to update the data of",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "description": "Other properties to set",
      "options": [
        {
          "displayName": "Color",
          "name": "color",
          "type": "options",
          "options": [
            {
              "name": "dark-blue",
              "value": "dark-blue"
            },
            {
              "name": "dark-brown",
              "value": "dark-brown"
            },
            {
              "name": "dark-green",
              "value": "dark-green"
            },
            {
              "name": "dark-orange",
              "value": "dark-orange"
            },
            {
              "name": "dark-pink",
              "value": "dark-pink"
            },
            {
              "name": "dark-purple",
              "value": "dark-purple"
            },
            {
              "name": "dark-red",
              "value": "dark-red"
            },
            {
              "name": "dark-teal",
              "value": "dark-teal"
            },
            {
              "name": "dark-warm-gray",
              "value": "dark-warm-gray"
            },
            {
              "name": "light-blue",
              "value": "light-blue"
            },
            {
              "name": "light-green",
              "value": "light-green"
            },
            {
              "name": "light-orange",
              "value": "light-orange"
            },
            {
              "name": "light-pink",
              "value": "light-pink"
            },
            {
              "name": "light-purple",
              "value": "light-purple"
            },
            {
              "name": "light-red",
              "value": "light-red"
            },
            {
              "name": "light-teal",
              "value": "light-teal"
            },
            {
              "name": "light-warm-gray",
              "value": "light-warm-gray"
            },
            {
              "name": "light-yellow",
              "value": "light-yellow"
            },
            {
              "name": "none",
              "value": "none"
            }
          ],
          "default": "none",
          "description": "Color of the project"
        },
        {
          "displayName": "Due On",
          "name": "due_on",
          "type": "dateTime",
          "default": "",
          "description": "The day on which this project is due. This takes a date with format YYYY-MM-DD."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The name of the project"
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": "",
          "description": "Basic description or notes for the project"
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "default": "",
          "description": "The new assignee/cardinal for this project"
        },
        {
          "displayName": "Privacy Setting",
          "name": "privacy_setting",
          "type": "options",
          "options": [
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Private to Team",
              "value": "private_to_team"
            },
            {
              "name": "Public to Workspace",
              "value": "public_to_workspace"
            }
          ],
          "default": "private",
          "description": "The privacy setting of the project"
        },
        {
          "displayName": "Team Name or ID",
          "name": "team",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspace"
            ],
            "loadOptionsMethod": "getTeams"
          },
          "default": "",
          "description": "The team this project will be assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a subtask"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many subtasks"
    }
  ]

credentials_required:
  [
    {
      "name": "asanaApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      },
      "testedBy": {
        "request": {
          "method": "GET",
          "url": "/users/me"
        }
      }
    },
    {
      "name": "asanaOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.asanaTrigger
package_name: n8n-nodes-base
display_name: Asana Trigger
description: Starts the workflow when Asana events occur.
category: trigger
development_style: programmatic
version: 1
operations: []
updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Asana Trigger node documentation
  description: Learn how to use the Asana Trigger node in n8n. Follow technical documentation to integrate Asana Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Asana Trigger node

  [Asana](https://asana.com/){:target=_blank .external-link} is a web and mobile application designed to help teams organize, track, and manage their work.

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "string",
      "default": "",
      "description": "The resource ID to subscribe to. The resource can be a task or project.",
      "required": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The workspace ID the resource is registered under. This is only required if you want to allow overriding existing webhooks. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    }
  ]

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


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Automizy node documentation
  description: Learn how to use the Automizy node in n8n. Follow technical documentation to integrate Automizy node into your workflows.
  contentType: [integration, reference]
  ---

  # Automizy node

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

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

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

  ## Operations

  * Contact
      * Create a contact
      * Delete a contact
      * Get a contact
      * Get all contacts
      * Update a contact
  * List
      * Create a list
      * Delete a list
      * Get a list
      * Get all lists
      * Update a list

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "This service may no longer exist and will be removed from n8n in a future release.",
      "name": "deprecated",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "List",
          "value": "list"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a contact",
          "action": "Create a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a contact",
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true,
            "loadOptionsMethod": "getCustomFields"
          },
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Key Name or ID",
                  "name": "key",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "description": "The end user specified key of the user defined data. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "description": "The end user specified value of the user defined data",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE"
            },
            {
              "name": "Banned",
              "value": "BANNED"
            },
            {
              "name": "Bounced",
              "value": "BOUNCED"
            },
            {
              "name": "Inactive",
              "value": "INACTIVE"
            },
            {
              "name": "Unsubscribed",
              "value": "UNSUBSCRIBED"
            }
          ],
          "default": "",
          "description": "The status of the contact. You can only send email to contacts with ACTIVE status."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The tags you want to set to the contact. 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": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Can be ID or email",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Can be ID or email",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "contact"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "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": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Direction",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Defines the direction in which search results are ordered. Default value is DESC. Note: It has to be using with the Sort By parameter"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "Defines the field in which search results are sort by. Note: It has to be using with the Direcction parameter"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Add Tag Names or IDs",
          "name": "addTags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The tags you want to add to the contact. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true,
            "loadOptionsMethod": "getCustomFields"
          },
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Key Name or ID",
                  "name": "key",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "description": "The end user specified key of the user defined data. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "description": "The end user specified value of the user defined data",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Remove Tags",
          "name": "removeTags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The tags you want to add to the contact. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE"
            },
            {
              "name": "Banned",
              "value": "BANNED"
            },
            {
              "name": "Bounced",
              "value": "BOUNCED"
            },
            {
              "name": "Inactive",
              "value": "INACTIVE"
            },
            {
              "name": "Unsubscribed",
              "value": "UNSUBSCRIBED"
            }
          ],
          "default": "",
          "description": "The status of the contact. You can only send email to contacts with ACTIVE status."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The tags you want to set to the contact. Will replace all existing ones. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a list",
          "action": "Delete a list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a list",
          "action": "Get a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many lists",
          "action": "Get many lists"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a list",
          "action": "Update a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "list"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Direction",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Defines the direction in which search results are ordered. Default value is DESC. Note: It has to be using with the Sort By parameter"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "Defines the field in which search results are sort by. Note: It has to be using with the Direcction parameter"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    }
  ]

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


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Autopilot node documentation
  description: Learn how to use the Autopilot node in n8n. Follow technical documentation to integrate Autopilot node into your workflows.
  contentType: [integration, reference]
  ---

  # Autopilot node

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

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

  /// warning | Autopilot branding change
  Autopilot has become Ortto. The Autopilot credentials and nodes are only compatible with Autopilot, not the new Ortto API.
  ///
  /// note | Credentials
  Refer to [Autopilot credentials](/integrations/builtin/credentials/autopilot.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Contact
      * Create/Update a contact
      * Delete a contact
      * Get a contact
      * Get all contacts
  * Contact Journey
      * Add contact to list
  * Contact List
      * Add contact to list
      * Check if contact is on list
      * Get all contacts on list
      * Remove a contact from a list
  * List
      * Create a list
      * Get all lists

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Contact Journey",
          "value": "contactJourney"
        },
        {
          "name": "Contact List",
          "value": "contactList"
        },
        {
          "name": "List",
          "value": "list"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new contact, or update the current one if it already exists (upsert)",
          "action": "Create or Update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company",
          "name": "Company",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true,
            "loadOptionsMethod": "getCustomFields"
          },
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Key Name or ID",
                  "name": "key",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "description": "User-specified key of user-defined data. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "description": "User-specified value of user-defined data",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Fax",
          "name": "Fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "FirstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Industry",
          "name": "Industry",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "LastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Lead Source",
          "name": "LeadSource",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn URL",
          "name": "LinkedIn",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "List Name or ID",
          "name": "autopilotList",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getLists"
          },
          "default": "",
          "description": "List to which this contact will be added on creation. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Mailing Country",
          "name": "MailingCountry",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mailing Postal Code",
          "name": "MailingPostalCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mailing State",
          "name": "MailingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mailing Street",
          "name": "MailingStreet",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mailing City",
          "name": "MailingCity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mobile Phone",
          "name": "MobilePhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "New Email",
          "name": "newEmail",
          "type": "string",
          "default": "",
          "description": "If provided, will change the email address of the contact identified by the Email field"
        },
        {
          "displayName": "Notify",
          "name": "notify",
          "type": "boolean",
          "default": true,
          "description": "By default Autopilot notifies registered REST hook endpoints for contact_added/contact_updated events when a new contact is added or an existing contact is updated via API. Disable to skip notifications."
        },
        {
          "displayName": "Number of Employees",
          "name": "NumberOfEmployees",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Owner Name",
          "name": "owner_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "Phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Salutation",
          "name": "Salutation",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Session ID",
          "name": "autopilotSessionId",
          "type": "string",
          "default": "",
          "description": "Used to associate a contact with a session"
        },
        {
          "displayName": "Status",
          "name": "Status",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Title",
          "name": "Title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Subscribe",
          "name": "unsubscribed",
          "type": "boolean",
          "default": false,
          "description": "Whether to subscribe or un-subscribe a contact"
        },
        {
          "displayName": "Website URL",
          "name": "Website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Can be ID or email",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Can be ID or email",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "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": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to list",
          "action": "Add a contact journey"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactJourney"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Trigger Name or ID",
      "name": "triggerId",
      "type": "options",
      "default": "",
      "description": "List ID. 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": [
            "add"
          ],
          "resource": [
            "contactJourney"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTriggers"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Can be ID or email",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "contactJourney"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to list",
          "action": "Add a contact to a list"
        },
        {
          "name": "Exist",
          "value": "exist",
          "description": "Check if contact is on list",
          "action": "Check if a contact list exists"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts from a list",
          "action": "Get many contact lists"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a contact from a list",
          "action": "Remove a contact from a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "ID of the list to operate on. 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": [
            "add",
            "remove",
            "exist",
            "getAll"
          ],
          "resource": [
            "contactList"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Can be ID or email",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add",
            "remove",
            "exist"
          ],
          "resource": [
            "contactList"
          ]
        }
      }
    },
    {
      "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": [
            "contactList"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "contactList"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many lists",
          "action": "Get many lists"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "list"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    }
  ]

operations:
  [
    {
      "operation": "upsert",
      "name": "Create or Update",
      "description": "Create a new contact, or update the current one if it already exists (upsert)"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a contact"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a contact"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many contacts"
    }
  ]


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Autopilot Trigger node documentation
  description: Learn how to use the Autopilot Trigger node in n8n. Follow technical documentation to integrate Autopilot Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Autopilot Trigger node

  [Autopilot](https://www.autopilothq.com/){:target=_blank .external-link} is a visual marketing software that allows you to automate and personalize your marketing across the entire customer journey.

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

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

  ## Events

  - Contact added
  - Contact added to a list
  - Contact entered to a segment
  - Contact left a segment
  - Contact removed from a list
  - Contact unsubscribed
  - Contact updated

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Contact Added",
          "value": "contactAdded"
        },
        {
          "name": "Contact Added To List",
          "value": "contactAddedToList"
        },
        {
          "name": "Contact Entered Segment",
          "value": "contactEnteredSegment"
        },
        {
          "name": "Contact Left Segment",
          "value": "contactLeftSegment"
        },
        {
          "name": "Contact Removed From List",
          "value": "contactRemovedFromList"
        },
        {
          "name": "Contact Unsubscribed",
          "value": "contactUnsubscribed"
        },
        {
          "name": "Contact Updated",
          "value": "contactUpdated"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.awsLambda
package_name: n8n-nodes-base
display_name: AWS Lambda
description: Invoke functions on AWS Lambda
category: output
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "invoke",
  "name": "Invoke",
  "description": "Invoke a function"
  }
  ]

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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Lambda node documentation
  description: Learn how to use the AWS Lambda node in n8n. Follow technical documentation to integrate AWS Lambda node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Lambda node

  Use the AWS Lambda node to automate work in AWS Lambda, and integrate AWS Lambda with other applications. n8n has built-in support for a wide range of AWS Lambda features, including invoking functions.

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

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

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

  ## Operations

  * Invoke a function

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "invoke",
      "options": [
        {
          "name": "Invoke",
          "value": "invoke",
          "description": "Invoke a function",
          "action": "Invoke a function"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Function Name or ID",
      "name": "function",
      "type": "options",
      "default": "",
      "description": "The function you want to invoke. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "invoke"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getFunctions"
      }
    },
    {
      "displayName": "Qualifier",
      "name": "qualifier",
      "type": "string",
      "default": "$LATEST",
      "description": "Specify a version or alias to invoke a published version of the function",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "invoke"
          ]
        }
      }
    },
    {
      "displayName": "Invocation Type",
      "name": "invocationType",
      "type": "options",
      "default": "RequestResponse",
      "description": "Specify if the workflow should wait for the function to return the results",
      "options": [
        {
          "name": "Wait for Results",
          "value": "RequestResponse",
          "description": "Invoke the function synchronously and wait for the response"
        },
        {
          "name": "Continue Workflow",
          "value": "Event",
          "description": "Invoke the function and immediately continue the workflow"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "invoke"
          ]
        }
      }
    },
    {
      "displayName": "JSON Input",
      "name": "payload",
      "type": "string",
      "default": "",
      "description": "The JSON that you want to provide to your Lambda function as input",
      "displayOptions": {
        "show": {
          "operation": [
            "invoke"
          ]
        }
      }
    }
  ]


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS SNS node documentation
  description: Learn how to use the AWS SNS node in n8n. Follow technical documentation to integrate AWS SNS node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS SNS node

  Use the AWS SNS node to automate work in AWS SNS, and integrate AWS SNS with other applications. n8n has built-in support for a wide range of AWS SNS features, including publishing messages.

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

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

  ## Operations

  * Publish a message to a topic

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "publish",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a topic",
          "action": "Create a topic"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a topic",
          "action": "Delete a topic"
        },
        {
          "name": "Publish",
          "value": "publish",
          "description": "Publish a message to a topic",
          "action": "Publish a message to a topic"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Display Name",
          "name": "displayName",
          "type": "string",
          "default": "",
          "description": "The display name to use for a topic with SMS subscriptions"
        },
        {
          "displayName": "Fifo Topic",
          "name": "fifoTopic",
          "type": "boolean",
          "default": false,
          "description": "Whether the topic you want to create is a FIFO (first-in-first-out) topic"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Topic",
      "name": "topic",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject when the message is delivered to email endpoints",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The message you want to send",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a topic"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a topic"
    },
    {
      "operation": "publish",
      "name": "Publish",
      "description": "Publish a message to a topic"
    }
  ]


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS SNS Trigger node documentation
  description: Learn how to use the AWS SNS Trigger node in n8n. Follow technical documentation to integrate AWS SNS Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS SNS Trigger node

  [AWS SNS](https://aws.amazon.com/sns/){:target=_blank .external-link} is a notification service provided as part of Amazon Web Services. It provides a low-cost infrastructure for the mass delivery of messages, predominantly to mobile users.

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

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

properties_schema:
  [
    {
      "displayName": "Topic",
      "name": "topic",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true
    }
  ]


node_type: nodes-base.awsCertificateManager
package_name: n8n-nodes-base
display_name: AWS Certificate Manager
description: Sends data to AWS Certificate Manager
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "aws",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Certificate Manager node documentation
  description: Learn how to use the AWS Certificate Manager node in n8n. Follow technical documentation to integrate AAWS Certificage Manager node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Certificate Manager node

  Use the AWS Certificate Manager node to automate work in AWS Certificate Manager, and integrate AWS Certificate Manager with other applications. n8n has built-in support for a wide range of AWS Certificate Manager features, including creating, deleting, getting, and renewing SSL certificates.

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

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

  ## Operations

  * Certificate
  	* Delete
  	* Get
  	* Get Many
  	* Get Metadata
  	* Renew

  ## Templates and examples

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

  ## Related resources

  Refer to [AWS Certificate Manager's documentation](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html){:target=_blank .external-link} for more information on this service.

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "certificate",
      "options": [
        {
          "name": "Certificate",
          "value": "certificate"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "renew",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a certificate",
          "action": "Delete a certificate"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a certificate",
          "action": "Get a certificate"
        },
        {
          "name": "Get Many",
          "value": "getMany",
          "description": "Get many certificates",
          "action": "Get many certificates"
        },
        {
          "name": "Get Metadata",
          "value": "getMetadata",
          "description": "Get certificate metadata",
          "action": "Get certificate metadata"
        },
        {
          "name": "Renew",
          "value": "renew",
          "description": "Renew a certificate",
          "action": "Renew a certificate"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "certificate"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Certificate ARN",
      "name": "certificateArn",
      "type": "string",
      "default": "",
      "description": "String that contains the ARN of the ACM certificate to be renewed. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "certificate"
          ],
          "operation": [
            "renew",
            "get",
            "delete",
            "getMetadata"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "certificate"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Certificate Key",
      "name": "certificateKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "certificate"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getMany"
          ],
          "resource": [
            "certificate"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getMany"
          ],
          "resource": [
            "certificate"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Certificate Statuses",
          "name": "certificateStatuses",
          "type": "multiOptions",
          "options": [
            {
              "name": "Expired",
              "value": "EXPIRED"
            },
            {
              "name": "Failed",
              "value": "FAILED"
            },
            {
              "name": "Inactive",
              "value": "INACTIVE"
            },
            {
              "name": "Issued",
              "value": "ISSUED"
            },
            {
              "name": "Pending Validation",
              "value": "PENDING_VALIDATION"
            },
            {
              "name": "Revoked",
              "value": "REVOKED"
            },
            {
              "name": "Validation Timed Out",
              "value": "VALIDATION_TIMED_OUT"
            }
          ],
          "default": [],
          "description": "Filter the certificate list by status value"
        },
        {
          "displayName": "Extended Key Usage",
          "name": "extendedKeyUsage",
          "type": "multiOptions",
          "options": [
            {
              "name": "Any",
              "value": "ANY"
            },
            {
              "name": "Code Signing",
              "value": "CODE_SIGNING"
            },
            {
              "name": "Custom",
              "value": "CUSTOM"
            },
            {
              "name": "Email Protection",
              "value": "EMAIL_PROTECTION"
            },
            {
              "name": "IPSEC End System",
              "value": "IPSEC_END_SYSTEM"
            },
            {
              "name": "IPSEC Tunnel",
              "value": "IPSEC_TUNNEL"
            },
            {
              "name": "IPSEC User",
              "value": "IPSEC_USER"
            },
            {
              "name": "None",
              "value": "NONE"
            },
            {
              "name": "OCSP Signing",
              "value": "OCSP_SIGNING"
            },
            {
              "name": "Time Stamping",
              "value": "TIME_STAMPING"
            },
            {
              "name": "TLS Web Client Authentication",
              "value": "TLS_WEB_CLIENT_AUTHENTICATION"
            },
            {
              "name": "TLS Web Server Authentication",
              "value": "TLS_WEB_SERVER_AUTHENTICATION"
            }
          ],
          "default": [],
          "description": "Specify one or more ExtendedKeyUsage extension values"
        },
        {
          "displayName": "Key Types",
          "name": "keyTypes",
          "type": "multiOptions",
          "options": [
            {
              "name": "EC Prime256v1",
              "value": "EC_prime256v1"
            },
            {
              "name": "EC Secp384r1",
              "value": "EC_secp384r1"
            },
            {
              "name": "EC Secp521r1",
              "value": "EC_secp521r1"
            },
            {
              "name": "RSA 1024",
              "value": "RSA_1024"
            },
            {
              "name": "RSA 2048",
              "value": "RSA_2048"
            },
            {
              "name": "RSA 4096",
              "value": "RSA_4096"
            }
          ],
          "default": [
            "RSA_2048"
          ],
          "description": "Specify one or more algorithms that can be used to generate key pairs"
        },
        {
          "displayName": "Key Usage",
          "name": "keyUsage",
          "type": "multiOptions",
          "options": [
            {
              "name": "Any",
              "value": "ANY"
            },
            {
              "name": "Certificate Signing",
              "value": "CERTIFICATE_SIGNING"
            },
            {
              "name": "CRL Signing",
              "value": "CRL_SIGNING"
            },
            {
              "name": "Custom",
              "value": "CUSTOM"
            },
            {
              "name": "Data Encipherment",
              "value": "DATA_ENCIPHERMENT"
            },
            {
              "name": "Decipher Only",
              "value": "DECIPHER_ONLY"
            },
            {
              "name": "Digital Signature",
              "value": "DIGITAL_SIGNATURE"
            },
            {
              "name": "Encipher Only",
              "value": "ENCIPHER_ONLY"
            },
            {
              "name": "Key Agreement",
              "value": "KEY_AGREEMENT"
            },
            {
              "name": "Key Encipherment",
              "value": "KEY_ENCIPHERMENT"
            },
            {
              "name": "Non Repudiation",
              "value": "NON_REPUDIATION"
            }
          ],
          "default": [],
          "description": "Specify one or more KeyUsage extension values"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "certificate"
          ],
          "operation": [
            "getMany"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a certificate"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a certificate"
    },
    {
      "operation": "getMany",
      "name": "Get Many",
      "description": "Get many certificates"
    },
    {
      "operation": "getMetadata",
      "name": "Get Metadata",
      "description": "Get certificate metadata"
    },
    {
      "operation": "renew",
      "name": "Renew",
      "description": "Renew a certificate"
    }
  ]


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

updated_at: 2025-06-24 11:07:34
properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Group",
          "value": "group"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "User Pool",
          "value": "userPool"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new group",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.CreateGroup"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "Group"
                  }
                }
              ]
            }
          },
          "action": "Create group"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an existing group",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.DeleteGroup"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"deleted\": true } }}"
                  }
                }
              ]
            }
          },
          "action": "Delete group"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve details of an existing group",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.GetGroup"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null
              ]
            }
          },
          "action": "Get group"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve a list of groups",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.ListGroups"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null,
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "Groups"
                  }
                }
              ]
            }
          },
          "action": "Get many groups"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an existing group",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.UpdateGroup"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"updated\": true } }}"
                  }
                }
              ]
            }
          },
          "action": "Update group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Group Name",
      "name": "newGroupName",
      "type": "string",
      "default": "",
      "description": "The name of the new group to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "default": "",
          "placeholder": "e.g. New group description",
          "description": "A description for the new group",
          "type": "string",
          "routing": {
            "send": {
              "type": "body",
              "property": "Description"
            }
          }
        },
        {
          "displayName": "Precedence",
          "name": "precedence",
          "default": "",
          "placeholder": "e.g. 10",
          "description": "Precedence value for the group. Lower values indicate higher priority.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "Precedence"
            }
          },
          "validateType": "number"
        },
        {
          "displayName": "Role ARN",
          "name": "arn",
          "default": "",
          "placeholder": "e.g. arn:aws:iam::123456789012:role/GroupRole",
          "description": "The role ARN for the group, used for setting claims in tokens",
          "type": "string",
          "routing": {
            "send": {
              "type": "body",
              "property": "Arn",
              "preSend": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Include Users",
      "name": "includeUsers",
      "type": "boolean",
      "default": false,
      "description": "Whether to include a list of users in the group",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "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": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "required": true,
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Include Users",
      "name": "includeUsers",
      "type": "boolean",
      "default": false,
      "description": "Whether to include a list of users in the group",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "default": "",
          "placeholder": "e.g. Updated group description",
          "description": "A new description for the group",
          "type": "string",
          "routing": {
            "send": {
              "type": "body",
              "property": "Description"
            }
          }
        },
        {
          "displayName": "Precedence",
          "name": "precedence",
          "default": "",
          "placeholder": "e.g. 10",
          "description": "The new precedence value for the group. Lower values indicate higher priority.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "Precedence"
            }
          },
          "validateType": "number"
        },
        {
          "displayName": "Role ARN",
          "name": "arn",
          "default": "",
          "placeholder": "e.g. arn:aws:iam::123456789012:role/GroupRole",
          "description": "A new role Amazon Resource Name (ARN) for the group. Used for setting claims in tokens.",
          "type": "string",
          "routing": {
            "send": {
              "type": "body",
              "property": "Arn",
              "preSend": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Add to Group",
          "value": "addToGroup",
          "description": "Add an existing user to a group",
          "action": "Add user to group",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.AdminAddUserToGroup"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"addedToGroup\": true } }}"
                  }
                }
              ]
            }
          }
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "action": "Create user",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.AdminCreateUser"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "User"
                  }
                }
              ]
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete user",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.AdminDeleteUser"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"deleted\": true } }}"
                  }
                }
              ]
            }
          }
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve information of an existing user",
          "action": "Get user",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.AdminGetUser"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null
              ]
            }
          }
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve a list of users",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.ListUsers"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null,
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "Users"
                  }
                }
              ]
            }
          },
          "action": "Get many users"
        },
        {
          "name": "Remove From Group",
          "value": "removeFromGroup",
          "description": "Remove a user from a group",
          "action": "Remove user from group",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.AdminRemoveUserFromGroup"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"removedFromGroup\": true } }}"
                  }
                }
              ]
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an existing user",
          "action": "Update user",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.AdminUpdateUserAttributes"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"updated\": true } }}"
                  }
                }
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User Name",
      "name": "newUserName",
      "type": "string",
      "default": "",
      "description": "Depending on the user pool settings, this parameter requires the username, the email, or the phone number. No whitespace is allowed.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Message Action",
          "name": "messageAction",
          "default": "RESEND",
          "type": "options",
          "options": [
            {
              "name": "Resend",
              "value": "RESEND",
              "description": "Resend the invitation message to a user that already exists and reset the expiration limit on the user's account"
            },
            {
              "name": "Suppress",
              "value": "SUPPRESS",
              "description": "Suppress sending the message"
            }
          ],
          "routing": {
            "send": {
              "property": "MessageAction",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Force Alias Creation",
          "name": "forceAliasCreation",
          "type": "boolean",
          "validateType": "boolean",
          "default": false,
          "description": "Whether this parameter is used only if the phone_number_verified or email_verified attribute is set to true. Otherwise, it is ignored. If set to true, and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the alias will be migrated. If set to false, an AliasExistsException error is thrown if the alias already exists.",
          "routing": {
            "send": {
              "type": "body",
              "property": "ForceAliasCreation"
            }
          }
        },
        {
          "displayName": "User Attributes",
          "name": "userAttributes",
          "type": "fixedCollection",
          "placeholder": "Add Attribute",
          "default": {
            "attributes": []
          },
          "required": true,
          "description": "Attributes to update for the user",
          "typeOptions": {
            "multipleValues": true
          },
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            }
          },
          "options": [
            {
              "displayName": "Attributes",
              "name": "attributes",
              "values": [
                {
                  "displayName": "Attribute Type",
                  "name": "attributeType",
                  "type": "options",
                  "default": "standard",
                  "options": [
                    {
                      "name": "Standard Attribute",
                      "value": "standard"
                    },
                    {
                      "name": "Custom Attribute",
                      "value": "custom"
                    }
                  ]
                },
                {
                  "displayName": "Standard Attribute",
                  "name": "standardName",
                  "type": "options",
                  "default": "address",
                  "options": [
                    {
                      "name": "Address",
                      "value": "address"
                    },
                    {
                      "name": "Birthdate",
                      "value": "birthdate"
                    },
                    {
                      "name": "Email",
                      "value": "email"
                    },
                    {
                      "name": "Email Verified",
                      "value": "email_verified"
                    },
                    {
                      "name": "Family Name",
                      "value": "family_name"
                    },
                    {
                      "name": "Gender",
                      "value": "gender"
                    },
                    {
                      "name": "Given Name",
                      "value": "given_name"
                    },
                    {
                      "name": "Locale",
                      "value": "locale"
                    },
                    {
                      "name": "Middle Name",
                      "value": "middle_name"
                    },
                    {
                      "name": "Name",
                      "value": "name"
                    },
                    {
                      "name": "Nickname",
                      "value": "nickname"
                    },
                    {
                      "name": "Phone Number",
                      "value": "phone_number"
                    },
                    {
                      "name": "Phone Number Verified",
                      "value": "phone_number_verified"
                    },
                    {
                      "name": "Preferred Username",
                      "value": "preferred_username"
                    },
                    {
                      "name": "Profile Picture",
                      "value": "profilepicture"
                    },
                    {
                      "name": "Updated At",
                      "value": "updated_at"
                    },
                    {
                      "name": "User Sub",
                      "value": "sub"
                    },
                    {
                      "name": "Website",
                      "value": "website"
                    },
                    {
                      "name": "Zone Info",
                      "value": "zoneinfo"
                    }
                  ],
                  "displayOptions": {
                    "show": {
                      "attributeType": [
                        "standard"
                      ]
                    }
                  }
                },
                {
                  "displayName": "Custom Attribute Name",
                  "name": "customName",
                  "type": "string",
                  "default": "",
                  "placeholder": "custom:myAttribute",
                  "description": "The name of the custom attribute (must start with \"custom:\")",
                  "displayOptions": {
                    "show": {
                      "attributeType": [
                        "custom"
                      ]
                    }
                  }
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value of the attribute"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Desired Delivery Mediums",
          "name": "desiredDeliveryMediums",
          "default": [
            "SMS"
          ],
          "description": "Specify how to send the welcome message",
          "type": "multiOptions",
          "options": [
            {
              "name": "SMS",
              "value": "SMS"
            },
            {
              "name": "Email",
              "value": "EMAIL"
            }
          ],
          "routing": {
            "send": {
              "preSend": [
                null
              ],
              "property": "DesiredDeliveryMediums",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Temporary Password",
          "name": "temporaryPasswordOptions",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "The user's temporary password that will be valid only once. If not set, Amazon Cognito will automatically generate one for you.",
          "routing": {
            "send": {
              "property": "TemporaryPassword",
              "type": "body"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "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": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "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": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "required": true,
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "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": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Filter",
          "name": "filter",
          "values": [
            {
              "displayName": "Attribute",
              "name": "attribute",
              "type": "options",
              "default": "email",
              "description": "The attribute to search for",
              "options": [
                {
                  "name": "Cognito User Status",
                  "value": "cognito:user_status"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "Family Name",
                  "value": "family_name"
                },
                {
                  "name": "Given Name",
                  "value": "given_name"
                },
                {
                  "name": "Name",
                  "value": "name"
                },
                {
                  "name": "Phone Number",
                  "value": "phone_number"
                },
                {
                  "name": "Preferred Username",
                  "value": "preferred_username"
                },
                {
                  "name": "Status (Enabled)",
                  "value": "status"
                },
                {
                  "name": "Sub",
                  "value": "sub"
                },
                {
                  "name": "Username",
                  "value": "username"
                }
              ]
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "The value of the attribute to search for"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User Attributes",
      "name": "userAttributes",
      "type": "fixedCollection",
      "default": {
        "attributes": []
      },
      "description": "Attributes to update for the user",
      "options": [
        {
          "displayName": "Attributes",
          "name": "attributes",
          "values": [
            {
              "displayName": "Attribute Type",
              "name": "attributeType",
              "type": "options",
              "default": "standard",
              "options": [
                {
                  "name": "Standard Attribute",
                  "value": "standard"
                },
                {
                  "name": "Custom Attribute",
                  "value": "custom"
                }
              ]
            },
            {
              "displayName": "Standard Attribute",
              "name": "standardName",
              "type": "options",
              "default": "address",
              "options": [
                {
                  "name": "Address",
                  "value": "address"
                },
                {
                  "name": "Birthdate",
                  "value": "birthdate"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "Family Name",
                  "value": "family_name"
                },
                {
                  "name": "Gender",
                  "value": "gender"
                },
                {
                  "name": "Given Name",
                  "value": "given_name"
                },
                {
                  "name": "Locale",
                  "value": "locale"
                },
                {
                  "name": "Middle Name",
                  "value": "middle_name"
                },
                {
                  "name": "Name",
                  "value": "name"
                },
                {
                  "name": "Nickname",
                  "value": "nickname"
                },
                {
                  "name": "Phone Number",
                  "value": "phone_number"
                },
                {
                  "name": "Preferred Username",
                  "value": "preferred_username"
                },
                {
                  "name": "Profile Picture",
                  "value": "profilepicture"
                },
                {
                  "name": "Updated At",
                  "value": "updated_at"
                },
                {
                  "name": "User Sub",
                  "value": "sub"
                },
                {
                  "name": "Website",
                  "value": "website"
                },
                {
                  "name": "Zone Info",
                  "value": "zoneinfo"
                }
              ],
              "displayOptions": {
                "show": {
                  "attributeType": [
                    "standard"
                  ]
                }
              }
            },
            {
              "displayName": "Custom Attribute Name",
              "name": "customName",
              "type": "string",
              "default": "",
              "placeholder": "custom:myAttribute",
              "description": "The name of the custom attribute (must start with \"custom:\")",
              "displayOptions": {
                "show": {
                  "attributeType": [
                    "custom"
                  ]
                }
              }
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "The value of the attribute"
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "addToGroup"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to add to the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "addToGroup"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to add the user to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "addToGroup"
          ]
        }
      }
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to use",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "removeFromGroup"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to remove from the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "removeFromGroup"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to remove the user from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "removeFromGroup"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get user pool",
          "routing": {
            "request": {
              "method": "POST",
              "headers": {
                "X-Amz-Target": "AWSCognitoIdentityProviderService.DescribeUserPool"
              }
            },
            "output": {
              "postReceive": [
                null,
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "UserPool"
                  }
                }
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userPool"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User Pool",
      "name": "userPool",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user pool to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userPool"
          ],
          "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": [
            "userPool"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new group"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an existing group"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve details of an existing group"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve a list of groups"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an existing group"
    }
  ]


node_type: nodes-base.awsComprehend
package_name: n8n-nodes-base
display_name: AWS Comprehend
description: Sends data to Amazon Comprehend
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "aws",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Comprehend node documentation
  description: Learn how to use the AWS Comprehend node in n8n. Follow technical documentation to integrate AWS Comprehend node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Comprehend node

  Use the AWS Comprehend node to automate work in AWS Comprehend, and integrate AWS Comprehend with other applications. n8n has built-in support for a wide range of AWS Comprehend features, including identifying and analyzing texts.

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

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

  ## Operations

  **Text**

  - Identify the dominant language
  - Analyse the sentiment of the text

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "text",
      "description": "The resource to perform",
      "options": [
        {
          "name": "Text",
          "value": "text"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "detectDominantLanguage",
      "options": [
        {
          "name": "Detect Dominant Language",
          "value": "detectDominantLanguage",
          "description": "Identify the dominant language",
          "action": "Identify the dominant language"
        },
        {
          "name": "Detect Entities",
          "value": "detectEntities",
          "description": "Inspects text for named entities, and returns information about them",
          "action": "Inspect text for named entities, and returns information about them"
        },
        {
          "name": "Detect Sentiment",
          "value": "detectSentiment",
          "description": "Analyse the sentiment of the text",
          "action": "Analyze the sentiment of the text"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Language Code",
      "name": "languageCode",
      "type": "options",
      "default": "en",
      "description": "The language code for text",
      "options": [
        {
          "name": "Arabic",
          "value": "ar"
        },
        {
          "name": "Chinese",
          "value": "zh"
        },
        {
          "name": "Chinese (T)",
          "value": "zh-TW"
        },
        {
          "name": "English",
          "value": "en"
        },
        {
          "name": "French",
          "value": "fr"
        },
        {
          "name": "German",
          "value": "de"
        },
        {
          "name": "Hindi",
          "value": "hi"
        },
        {
          "name": "Italian",
          "value": "it"
        },
        {
          "name": "Japanese",
          "value": "ja"
        },
        {
          "name": "Korean",
          "value": "ko"
        },
        {
          "name": "Portuguese",
          "value": "pt"
        },
        {
          "name": "Spanish",
          "value": "es"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "detectSentiment",
            "detectEntities"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The text to send",
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ]
        }
      }
    },
    {
      "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": [
            "text"
          ],
          "operation": [
            "detectDominantLanguage"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Endpoint Arn",
          "name": "endpointArn",
          "type": "string",
          "default": "",
          "description": "The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "detectEntities"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "detectDominantLanguage",
      "name": "Detect Dominant Language",
      "description": "Identify the dominant language"
    },
    {
      "operation": "detectEntities",
      "name": "Detect Entities",
      "description": "Inspects text for named entities, and returns information about them"
    },
    {
      "operation": "detectSentiment",
      "name": "Detect Sentiment",
      "description": "Analyse the sentiment of the text"
    }
  ]


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS DynamoDB node documentation
  description: Learn how to use the AWS DynamoDB node in n8n. Follow technical documentation to integrate AWS DynamoDB node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS DynamoDB node

  Use the AWS DynamoDB node to automate work in AWS DynamoDB, and integrate AWS DynamoDB with other applications. n8n has built-in support for a wide range of AWS DynamoDB features, including creating, reading, updating, deleting items, and records on a database.

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

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

  ## Operations

  * Item
    * Create a new record, or update the current one if it already exists (upsert/put)
    * Delete an item
    * Get an item
    * Get all items

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "item",
      "options": [
        {
          "name": "Item",
          "value": "item"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new record, or update the current one if it already exists (upsert)",
          "action": "Create or update an item"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an item",
          "action": "Delete an item"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an item",
          "action": "Get an item"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many items",
          "action": "Get many items"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableName",
      "type": "options",
      "default": [],
      "description": "Table to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "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": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "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": {
          "operation": [
            "upsert"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field ID",
              "name": "fieldId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Expression Attribute Values",
          "name": "eavUi",
          "description": "Substitution tokens for attribute names in an expression. Only needed when the parameter \"condition expression\" is set.",
          "placeholder": "Add Attribute Value",
          "type": "fixedCollection",
          "default": {},
          "required": true,
          "typeOptions": {
            "multipleValues": true,
            "minValue": 1
          },
          "options": [
            {
              "name": "eavValues",
              "displayName": "Expression Attribute Vaue",
              "values": [
                {
                  "displayName": "Attribute",
                  "name": "attribute",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Number",
                      "value": "N"
                    },
                    {
                      "name": "String",
                      "value": "S"
                    }
                  ],
                  "default": "S"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Condition Expression",
          "name": "conditionExpression",
          "type": "string",
          "default": "",
          "description": "A condition that must be satisfied in order for a conditional upsert to succeed. <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html\">View details</a>."
        },
        {
          "displayName": "Expression Attribute Names",
          "name": "eanUi",
          "placeholder": "Add Expression",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "eanValues",
              "displayName": "Expression",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ],
          "description": "One or more substitution tokens for attribute names in an expression. <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html\">View details</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Return",
      "name": "returnValues",
      "type": "options",
      "default": "NONE",
      "description": "Use ReturnValues if you want to get the item attributes as they appeared before they were deleted",
      "options": [
        {
          "name": "Attribute Values",
          "value": "ALL_OLD",
          "description": "The content of the old item is returned"
        },
        {
          "name": "Nothing",
          "value": "NONE",
          "description": "Nothing is returned"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Keys",
      "name": "keysUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Item's primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.",
      "options": [
        {
          "displayName": "Key",
          "name": "keyValues",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Binary",
                  "value": "B"
                },
                {
                  "name": "Number",
                  "value": "N"
                },
                {
                  "name": "String",
                  "value": "S"
                }
              ],
              "default": "S"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "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": [
            "item"
          ],
          "operation": [
            "delete"
          ],
          "returnValues": [
            "ALL_OLD"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Condition Expression",
          "name": "conditionExpression",
          "type": "string",
          "default": "",
          "description": "A condition that must be satisfied in order for a conditional delete to succeed"
        },
        {
          "displayName": "Expression Attribute Names",
          "name": "eanUi",
          "placeholder": "Add Expression",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "eanValues",
              "displayName": "Expression",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ],
          "description": "One or more substitution tokens for attribute names in an expression. Check <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html\">Info</a>."
        },
        {
          "displayName": "Expression Attribute Values",
          "name": "expressionAttributeUi",
          "description": "Substitution tokens for attribute names in an expression. Only needed when the parameter \"condition expression\" is set.",
          "placeholder": "Add Attribute Value",
          "type": "fixedCollection",
          "default": {},
          "required": true,
          "typeOptions": {
            "multipleValues": true,
            "minValue": 1
          },
          "options": [
            {
              "name": "expressionAttributeValues",
              "displayName": "Expression Attribute Vaue",
              "values": [
                {
                  "displayName": "Attribute",
                  "name": "attribute",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Number",
                      "value": "N"
                    },
                    {
                      "name": "String",
                      "value": "S"
                    }
                  ],
                  "default": "S"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Select",
      "name": "select",
      "type": "options",
      "default": "ALL_ATTRIBUTES",
      "options": [
        {
          "name": "All Attributes",
          "value": "ALL_ATTRIBUTES"
        },
        {
          "name": "All Projected Attributes",
          "value": "ALL_PROJECTED_ATTRIBUTES"
        },
        {
          "name": "Specific Attributes",
          "value": "SPECIFIC_ATTRIBUTES",
          "description": "Select them in Attributes to Select under Additional Fields"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "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": [
            "item"
          ],
          "operation": [
            "get"
          ],
          "select": [
            "ALL_PROJECTED_ATTRIBUTES",
            "ALL_ATTRIBUTES"
          ]
        }
      }
    },
    {
      "displayName": "Keys",
      "name": "keysUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Item's primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.",
      "options": [
        {
          "displayName": "Key",
          "name": "keyValues",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Binary",
                  "value": "B"
                },
                {
                  "name": "Number",
                  "value": "N"
                },
                {
                  "name": "String",
                  "value": "S"
                }
              ],
              "default": "S"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attributes to Select",
          "name": "projectionExpression",
          "type": "string",
          "placeholder": "id, name",
          "default": ""
        },
        {
          "displayName": "Expression Attribute Names",
          "name": "eanUi",
          "placeholder": "Add Expression",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "eanValues",
              "displayName": "Expression",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ],
          "description": "One or more substitution tokens for attribute names in an expression. <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html\">View details</a>."
        },
        {
          "displayName": "Read Type",
          "name": "readType",
          "type": "options",
          "options": [
            {
              "name": "Strongly Consistent Read",
              "value": "stronglyConsistentRead"
            },
            {
              "name": "Eventually Consistent Read",
              "value": "eventuallyConsistentRead"
            }
          ],
          "default": "eventuallyConsistentRead",
          "description": "Type of read to perform on the table. <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html\">View details</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Scan",
      "name": "scan",
      "type": "boolean",
      "default": false,
      "description": "Whether to do an scan or query. Check <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-query-scan.html\" >differences</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filter Expression",
      "name": "filterExpression",
      "type": "string",
      "default": "",
      "description": "A filter expression determines which items within the Scan results should be returned to you. All of the other results are discarded. Empty value will return all Scan results.",
      "displayOptions": {
        "show": {
          "scan": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Key Condition Expression",
      "name": "keyConditionExpression",
      "type": "string",
      "default": "",
      "description": "Condition to determine the items to be retrieved. The condition must perform an equality test on a single partition key value, in this format: <code>partitionKeyName = :partitionkeyval</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ],
          "scan": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Expression Attribute Values",
      "name": "eavUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Substitution tokens for attribute names in an expression",
      "options": [
        {
          "name": "eavValues",
          "displayName": "Expression Attribute Vaue",
          "values": [
            {
              "displayName": "Attribute",
              "name": "attribute",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Number",
                  "value": "N"
                },
                {
                  "name": "String",
                  "value": "S"
                }
              ],
              "default": "S"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "minValue": 1
      }
    },
    {
      "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": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Select",
      "name": "select",
      "type": "options",
      "default": "ALL_ATTRIBUTES",
      "options": [
        {
          "name": "All Attributes",
          "value": "ALL_ATTRIBUTES"
        },
        {
          "name": "All Projected Attributes",
          "value": "ALL_PROJECTED_ATTRIBUTES"
        },
        {
          "name": "Count",
          "value": "COUNT"
        },
        {
          "name": "Specific Attributes",
          "value": "SPECIFIC_ATTRIBUTES",
          "description": "Select them in Attributes to Select under Additional Fields"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "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": [
            "item"
          ],
          "operation": [
            "getAll"
          ],
          "select": [
            "ALL_PROJECTED_ATTRIBUTES",
            "ALL_ATTRIBUTES",
            "SPECIFIC_ATTRIBUTES"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Index Name",
          "name": "indexName",
          "description": "Name of the index to query. It can be any secondary local or global index on the table.",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Attributes to Select",
          "name": "projectionExpression",
          "type": "string",
          "default": "",
          "description": "Text that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas."
        },
        {
          "displayName": "Filter Expression",
          "name": "filterExpression",
          "type": "string",
          "displayOptions": {
            "show": {
              "/scan": [
                false
              ]
            }
          },
          "default": "",
          "description": "Text that contains conditions that DynamoDB applies after the Query operation, but before the data is returned. Items that do not satisfy the FilterExpression criteria are not returned."
        },
        {
          "displayName": "Expression Attribute Names",
          "name": "eanUi",
          "placeholder": "Add Expression",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "eanValues",
              "displayName": "Expression",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ],
          "description": "One or more substitution tokens for attribute names in an expression. Check <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html\">Info</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "upsert",
      "name": "Create or Update",
      "description": "Create a new record, or update the current one if it already exists (upsert)"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an item"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an item"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many items"
    }
  ]


node_type: nodes-base.awsElb
package_name: n8n-nodes-base
display_name: AWS ELB
description: Sends data to AWS ELB API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "aws",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Elastic Load Balancing node documentation
  description: Learn how to use the AWS Elastic Load Balancing node in n8n. Follow technical documentation to integrate AWS Elastic Load Balancing node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Elastic Load Balancing node

  Use the AWS Elastic Load Balancing node to automate work in AWS ELB, and integrate AWS ELB with other applications. n8n has built-in support for a wide range of AWS ELB features, including adding, getting, removing, deleting certificates and load balancers.

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

  /// note | Credentials
  Refer to [AWS ELB credentials](/integrations/builtin/credentials/aws.md){:target=_blank .external-link} for guidance on setting up authentication. 
  ///

  ## Operations

  * Listener Certificate
  	* Add
  	* Get Many
  	* Remove
  * Load Balancer
  	* Create
  	* Delete
  	* Get
  	* Get Many

  This node supports creating and managing application and network load balancers. It doesn't currently support gateway load balancers.

  ## Templates and examples

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

  ## Related resources

  Refer to [AWS ELB's documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/what-is-load-balancing.html){:target=_blank .external-link} for more information on this service.

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "loadBalancer",
      "options": [
        {
          "name": "Listener Certificate",
          "value": "listenerCertificate"
        },
        {
          "name": "Load Balancer",
          "value": "loadBalancer"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a load balancer",
          "action": "Create a load balancer"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a load balancer",
          "action": "Delete a load balancer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a load balancer",
          "action": "Get a load balancer"
        },
        {
          "name": "Get Many",
          "value": "getMany",
          "description": "Get many load balancers",
          "action": "Get many load balancers"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "IP Address Type",
      "name": "ipAddressType",
      "type": "options",
      "default": "ipv4",
      "description": "The type of IP addresses used by the subnets for your load balancer",
      "options": [
        {
          "name": "Ipv4",
          "value": "ipv4"
        },
        {
          "name": "Dualstack",
          "value": "dualstack"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "This name must be unique per region per account, can have a maximum of 32 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Schema",
      "name": "schema",
      "type": "options",
      "default": "internet-facing",
      "options": [
        {
          "name": "Internal",
          "value": "internal"
        },
        {
          "name": "Internet Facing",
          "value": "internet-facing"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "application",
      "options": [
        {
          "name": "Application",
          "value": "application"
        },
        {
          "name": "Network",
          "value": "network"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subnet ID Names or IDs",
      "name": "subnets",
      "type": "multiOptions",
      "default": [],
      "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSubnets"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Security Group IDs",
          "name": "securityGroups",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getSecurityGroups"
          },
          "default": []
        },
        {
          "displayName": "Tags",
          "name": "tagsUi",
          "placeholder": "Add Tag",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "tagValues",
              "displayName": "Tag",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The key of the tag"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value of the tag"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "loadBalancer"
          ]
        }
      }
    },
    {
      "displayName": "Load Balancer ARN",
      "name": "loadBalancerId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "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": [
            "loadBalancer"
          ],
          "operation": [
            "getMany"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "getMany"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "maxValue": 400,
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Names",
          "name": "names",
          "type": "string",
          "default": "",
          "description": "The names of the load balancers. Multiples can be defined separated by comma."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getMany"
          ],
          "resource": [
            "loadBalancer"
          ],
          "returnAll": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Load Balancer ARN",
      "name": "loadBalancerId",
      "type": "string",
      "default": "",
      "description": "ID of loadBalancer to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "loadBalancer"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener",
          "action": "Add a listener certificate"
        },
        {
          "name": "Get Many",
          "value": "getMany",
          "description": "Get many listener certificates",
          "action": "Get many listener certificates"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove the specified certificate from the certificate list for the specified HTTPS or TLS listener",
          "action": "Remove a listener certificate"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "listenerCertificate"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Load Balancer ARN Name or ID",
      "name": "loadBalancerId",
      "type": "options",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer. 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": [
            "listenerCertificate"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLoadBalancers"
      }
    },
    {
      "displayName": "Listener ARN Name or ID",
      "name": "listenerId",
      "type": "options",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer. 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": [
            "listenerCertificate"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLoadBalancerListeners",
        "loadOptionsDependsOn": [
          "loadBalancerId"
        ]
      }
    },
    {
      "displayName": "Certificate ARN",
      "name": "certificateId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "listenerCertificate"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Load Balancer ARN Name or ID",
      "name": "loadBalancerId",
      "type": "options",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer. 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": [
            "listenerCertificate"
          ],
          "operation": [
            "getMany"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLoadBalancers"
      }
    },
    {
      "displayName": "Listener ARN Name or ID",
      "name": "listenerId",
      "type": "options",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer. 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": [
            "listenerCertificate"
          ],
          "operation": [
            "getMany"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLoadBalancerListeners",
        "loadOptionsDependsOn": [
          "loadBalancerId"
        ]
      }
    },
    {
      "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": [
            "listenerCertificate"
          ],
          "operation": [
            "getMany"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "listenerCertificate"
          ],
          "operation": [
            "getMany"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "maxValue": 400,
        "minValue": 1
      }
    },
    {
      "displayName": "Load Balancer ARN Name or ID",
      "name": "loadBalancerId",
      "type": "options",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer. 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": [
            "listenerCertificate"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLoadBalancers"
      }
    },
    {
      "displayName": "Listener ARN Name or ID",
      "name": "listenerId",
      "type": "options",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer. 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": [
            "listenerCertificate"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLoadBalancerListeners",
        "loadOptionsDependsOn": [
          "loadBalancerId"
        ]
      }
    },
    {
      "displayName": "Certificate ARN",
      "name": "certificateId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular loadBalancer",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "listenerCertificate"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a load balancer"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a load balancer"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a load balancer"
    },
    {
      "operation": "getMany",
      "name": "Get Many",
      "description": "Get many load balancers"
    }
  ]


node_type: nodes-base.awsIam
package_name: n8n-nodes-base
display_name: AWS IAM
description: Interacts with Amazon IAM
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "aws",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "Group",
          "value": "group"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Add to Group",
          "value": "addToGroup",
          "description": "Add an existing user to a group",
          "action": "Add user to group",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "AddUserToGroup",
                "Version": "2010-05-08",
                "UserName": "={{ $parameter[\"user\"] }}",
                "GroupName": "={{ $parameter[\"group\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "action": "Create user",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "CreateUser",
                "Version": "2010-05-08",
                "UserName": "={{ $parameter[\"userName\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete user",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "DeleteUser",
                "Version": "2010-05-08",
                "UserName": "={{ $parameter[\"user\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a user",
          "action": "Get user",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "GetUser",
                "Version": "2010-05-08",
                "UserName": "={{ $parameter[\"user\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "GetUserResponse.GetUserResult.User"
                  }
                },
                null
              ]
            }
          }
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve a list of users",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "ListUsers",
                "Version": "2010-05-08"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null
              ]
            }
          },
          "action": "Get many users"
        },
        {
          "name": "Remove From Group",
          "value": "removeFromGroup",
          "description": "Remove a user from a group",
          "action": "Remove user from group",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "RemoveUserFromGroup",
                "Version": "2010-05-08",
                "UserName": "={{ $parameter[\"user\"] }}",
                "GroupName": "={{ $parameter[\"group\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user",
          "action": "Update user",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "UpdateUser",
                "Version": "2010-05-08",
                "NewUserName": "={{ $parameter[\"userName\"] }}",
                "UserName": "={{ $parameter[\"user\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to add to the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "addToGroup"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to add the user to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "addToGroup"
          ]
        }
      }
    },
    {
      "displayName": "User Name",
      "name": "userName",
      "type": "string",
      "default": "",
      "description": "The username of the new user to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "maxLength": 64,
        "regex": "^[A-Za-z0-9+=,\\.@_-]+$"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Path",
          "name": "path",
          "type": "string",
          "validateType": "string",
          "default": "/",
          "description": "The path for the user name",
          "placeholder": "e.g. /division_abc/subdivision_xyz/",
          "routing": {
            "send": {
              "preSend": [
                null
              ],
              "property": "Path",
              "type": "query"
            }
          }
        },
        {
          "displayName": "Permissions Boundary",
          "name": "permissionsBoundary",
          "default": "",
          "description": "The ARN of the managed policy that is used to set the permissions boundary for the user",
          "placeholder": "e.g. arn:aws:iam::123456789012:policy/ExampleBoundaryPolicy",
          "type": "string",
          "validateType": "string",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "fixedCollection",
          "description": "A list of tags that you want to attach to the new user",
          "default": [],
          "placeholder": "Add Tag",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "tags",
              "displayName": "Tag",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "placeholder": "e.g., Department"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "e.g., Engineering"
                }
              ]
            }
          ],
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "hide": {
          "returnAll": [
            true
          ]
        },
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Path Prefix",
          "name": "pathPrefix",
          "type": "string",
          "validateType": "string",
          "default": "/",
          "description": "The path prefix for filtering the results",
          "placeholder": "e.g. /division_abc/subdivision_xyz/",
          "routing": {
            "send": {
              "preSend": [
                null
              ],
              "property": "PathPrefix",
              "value": "={{ $value }}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User Name",
      "name": "userName",
      "type": "string",
      "default": "",
      "description": "The new name of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "maxLength": 64,
        "regex": "^[A-Za-z0-9+=,\\.@_-]+$"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Path",
          "name": "path",
          "type": "string",
          "validateType": "string",
          "default": "/",
          "placeholder": "e.g. /division_abc/subdivision_xyz/",
          "routing": {
            "send": {
              "preSend": [
                null
              ],
              "property": "NewPath",
              "type": "query"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "user",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the user you want to remove from the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "removeFromGroup"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to remove the user from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "removeFromGroup"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create group",
          "description": "Create a new group",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "CreateGroup",
                "Version": "2010-05-08",
                "GroupName": "={{ $parameter[\"groupName\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete group",
          "description": "Delete an existing group",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "DeleteGroup",
                "Version": "2010-05-08",
                "GroupName": "={{ $parameter[\"group\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get group",
          "description": "Retrieve details of an existing group",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "GetGroup",
                "Version": "2010-05-08",
                "GroupName": "={{ $parameter[\"group\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null
              ]
            }
          }
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many groups",
          "description": "Retrieve a list of groups",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "ListGroups",
                "Version": "2010-05-08"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null,
                null
              ]
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update group",
          "description": "Update an existing group",
          "routing": {
            "request": {
              "method": "POST",
              "url": "",
              "body": {
                "Action": "UpdateGroup",
                "Version": "2010-05-08",
                "GroupName": "={{ $parameter[\"group\"] }}",
                "NewGroupName": "={{ $parameter[\"groupName\"] }}"
              },
              "ignoreHttpStatusErrors": true
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Group Name",
      "name": "groupName",
      "type": "string",
      "default": "",
      "description": "The name of the new group to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "maxLength": 128,
        "regex": "^[+=,.@\\-_A-Za-z0-9]+$"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Path",
          "name": "path",
          "type": "string",
          "validateType": "string",
          "default": "/",
          "placeholder": "e.g. /division_abc/engineering/",
          "description": "The path to the group, if it is not included, it defaults to a slash (/)",
          "routing": {
            "send": {
              "preSend": [
                null
              ],
              "property": "Path",
              "type": "query"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Include Users",
      "name": "includeUsers",
      "type": "boolean",
      "default": false,
      "description": "Whether to include a list of users in the group",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "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": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "hide": {
          "returnAll": [
            true
          ]
        },
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Include Users",
      "name": "includeUsers",
      "type": "boolean",
      "default": false,
      "description": "Whether to include a list of users in the group",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "Select the group you want to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Group Name",
      "name": "groupName",
      "type": "string",
      "default": "",
      "description": "The new name of the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "maxLength": 128,
        "regex": "^[+=,.@\\-_A-Za-z0-9]+$"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Path",
          "name": "path",
          "type": "string",
          "validateType": "string",
          "default": "/",
          "placeholder": "e.g. /division_abc/engineering/",
          "description": "The new path to the group, if it is not included, it defaults to a slash (/)",
          "routing": {
            "send": {
              "preSend": [
                null
              ],
              "property": "NewPath",
              "type": "query"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "addToGroup",
      "name": "Add to Group",
      "description": "Add an existing user to a group"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new user"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a user"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve a user"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve a list of users"
    },
    {
      "operation": "removeFromGroup",
      "name": "Remove From Group",
      "description": "Remove a user from a group"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a user"
    }
  ]


node_type: nodes-base.awsRekognition
package_name: n8n-nodes-base
display_name: AWS Rekognition
description: Sends data to AWS Rekognition
category: output
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "analyze",
  "name": "Analyze"
  }
  ]

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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Rekognition node documentation
  description: Learn how to use the AWS Rekognition node in n8n. Follow technical documentation to integrate AWS Rekognition node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Rekognition node

  Use the AWS Rekognition node to automate work in AWS Rekognition, and integrate AWS Rekognition with other applications. n8n has built-in support for a wide range of AWS Rekognition features, including analyzing images.

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

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

  ## Operations

  **Image**

  - Analyze

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "image",
      "options": [
        {
          "name": "Image",
          "value": "image"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "analyze",
      "options": [
        {
          "name": "Analyze",
          "value": "analyze"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "detectFaces",
      "options": [
        {
          "name": "Detect Faces",
          "value": "detectFaces"
        },
        {
          "name": "Detect Labels",
          "value": "detectLabels"
        },
        {
          "name": "Detect Moderation Labels",
          "value": "detectModerationLabels"
        },
        {
          "name": "Detect Text",
          "value": "detectText"
        },
        {
          "name": "Recognize Celebrity",
          "value": "recognizeCelebrity"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "analyze"
          ],
          "resource": [
            "image"
          ]
        }
      }
    },
    {
      "displayName": "Binary File",
      "name": "binaryData",
      "type": "boolean",
      "default": false,
      "description": "Whether the image to analyze should be taken from binary field",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "analyze"
          ],
          "resource": [
            "image"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "analyze"
          ],
          "resource": [
            "image"
          ],
          "binaryData": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Bucket",
      "name": "bucket",
      "type": "string",
      "default": "",
      "description": "Name of the S3 bucket",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "analyze"
          ],
          "resource": [
            "image"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "S3 object key name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "analyze"
          ],
          "resource": [
            "image"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Regions of Interest",
          "name": "regionsOfInterestUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Region of Interest",
          "displayOptions": {
            "show": {
              "/type": [
                "detectText"
              ]
            }
          },
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "regionsOfInterestValues",
              "displayName": "Region of Interest",
              "values": [
                {
                  "displayName": "Height",
                  "name": "height",
                  "type": "number",
                  "description": "Height of the bounding box as a ratio of the overall image height",
                  "default": 0
                },
                {
                  "displayName": "Left",
                  "name": "left",
                  "type": "number",
                  "description": "Left coordinate of the bounding box as a ratio of overall image width",
                  "default": 0
                },
                {
                  "displayName": "Top",
                  "name": "top",
                  "type": "number",
                  "description": "Top coordinate of the bounding box as a ratio of overall image height",
                  "default": 0
                },
                {
                  "displayName": "Width",
                  "name": "Width",
                  "type": "number",
                  "description": "Width of the bounding box as a ratio of the overall image width",
                  "default": 0
                }
              ]
            }
          ]
        },
        {
          "displayName": "Version",
          "name": "version",
          "displayOptions": {
            "show": {
              "/binaryData": [
                false
              ]
            }
          },
          "type": "string",
          "default": "",
          "description": "If the bucket is versioning enabled, you can specify the object version"
        },
        {
          "displayName": "Word Filter",
          "name": "wordFilterUi",
          "type": "collection",
          "default": {},
          "placeholder": "Add Word Filter",
          "displayOptions": {
            "show": {
              "/type": [
                "detectText"
              ]
            }
          },
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Min Bounding Box Height",
              "name": "MinBoundingBoxHeight",
              "type": "number",
              "description": "Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.",
              "default": 0
            },
            {
              "displayName": "Min Bounding Box Width",
              "name": "MinBoundingBoxWidth",
              "type": "number",
              "description": "Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.",
              "default": 0
            },
            {
              "displayName": "Min Confidence",
              "name": "MinConfidence",
              "type": "number",
              "description": "Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.",
              "default": 0
            }
          ]
        },
        {
          "displayName": "Max Labels",
          "name": "maxLabels",
          "type": "number",
          "displayOptions": {
            "show": {
              "/type": [
                "detectModerationLabels",
                "detectLabels"
              ]
            }
          },
          "default": 0,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels."
        },
        {
          "displayName": "Min Confidence",
          "name": "minConfidence",
          "type": "number",
          "displayOptions": {
            "show": {
              "/type": [
                "detectModerationLabels",
                "detectLabels"
              ]
            }
          },
          "default": 0,
          "typeOptions": {
            "minValue": 0,
            "maxValue": 100
          },
          "description": "Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value."
        },
        {
          "displayName": "Attributes",
          "name": "attributes",
          "type": "multiOptions",
          "displayOptions": {
            "show": {
              "/type": [
                "detectFaces"
              ]
            }
          },
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Default",
              "value": "default"
            }
          ],
          "default": [],
          "description": "An array of facial attributes you want to be returned"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "analyze"
          ],
          "resource": [
            "image"
          ]
        }
      }
    }
  ]


node_type: nodes-base.awsS3
package_name: n8n-nodes-base
display_name: AwsS3
description: Sends data to AWS S3
category: output
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "aws",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS S3 node documentation
  description: Learn how to use the AWS S3 node in n8n. Follow technical documentation to integrate AWS S3 node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # AWS S3 node

  Use the AWS S3 node to automate work in AWS S3, and integrate AWS S3 with other applications. n8n has built-in support for a wide range of AWS S3 features, including creating and deleting buckets, copying and downloading files, as well as getting folders.

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

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

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

  ## Operations

  * Bucket
      * Create a bucket
      * Delete a bucket
      * Get all buckets
      * Search within a bucket
  * File
      * Copy a file
      * Delete a file
      * Download a file
      * Get all files
      * Upload a file
  * Folder
      * Create a folder
      * Delete a folder
      * Get all folders

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "file",
      "options": [
        {
          "name": "Bucket",
          "value": "bucket"
        },
        {
          "name": "File",
          "value": "file"
        },
        {
          "name": "Folder",
          "value": "folder"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a bucket",
          "action": "Create a bucket"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a bucket",
          "action": "Delete a bucket"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many buckets",
          "action": "Get many buckets"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search within a bucket",
          "action": "Search a bucket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "A succinct description of the nature, symptoms, cause, or effect of the bucket",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "ACL",
          "name": "acl",
          "type": "options",
          "options": [
            {
              "name": "Authenticated Read",
              "value": "authenticatedRead"
            },
            {
              "name": "Private",
              "value": "Private"
            },
            {
              "name": "Public Read",
              "value": "publicRead"
            },
            {
              "name": "Public Read Write",
              "value": "publicReadWrite"
            }
          ],
          "default": "",
          "description": "The canned ACL to apply to the bucket"
        },
        {
          "displayName": "Bucket Object Lock Enabled",
          "name": "bucketObjectLockEnabled",
          "type": "boolean",
          "default": false,
          "description": "Whether you want S3 Object Lock to be enabled for the new bucket"
        },
        {
          "displayName": "Grant Full Control",
          "name": "grantFullControl",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee the read, write, read ACP, and write ACP permissions on the bucket"
        },
        {
          "displayName": "Grant Read",
          "name": "grantRead",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to list the objects in the bucket"
        },
        {
          "displayName": "Grant Read ACP",
          "name": "grantReadAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the bucket ACL"
        },
        {
          "displayName": "Grant Write",
          "name": "grantWrite",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to create, overwrite, and delete any object in the bucket"
        },
        {
          "displayName": "Grant Write ACP",
          "name": "grantWriteAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to write the ACL for the applicable bucket"
        },
        {
          "displayName": "Region",
          "name": "region",
          "type": "string",
          "default": "",
          "description": "Region you want to create the bucket in, by default the buckets are created on the region defined on the credentials"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the AWS S3 bucket to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "bucket"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "bucket"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "bucket"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "bucket"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delimiter",
          "name": "delimiter",
          "type": "string",
          "default": "",
          "description": "A delimiter is a character you use to group keys"
        },
        {
          "displayName": "Encoding Type",
          "name": "encodingType",
          "type": "options",
          "options": [
            {
              "name": "URL",
              "value": "url"
            }
          ],
          "default": "",
          "description": "Encoding type used by Amazon S3 to encode object keys in the response"
        },
        {
          "displayName": "Fetch Owner",
          "name": "fetchOwner",
          "type": "boolean",
          "default": false,
          "description": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true"
        },
        {
          "displayName": "Prefix",
          "name": "prefix",
          "type": "string",
          "default": "",
          "description": "Limits the response to keys that begin with the specified prefix"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Start After",
          "name": "startAfter",
          "type": "string",
          "default": "",
          "description": "StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a folder",
          "action": "Create a folder"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a folder",
          "action": "Delete a folder"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many folders",
          "action": "Get many folders"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Folder Name",
      "name": "folderName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Parent Folder Key",
          "name": "parentFolderKey",
          "type": "string",
          "default": "",
          "description": "Parent folder you want to create the folder in"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Storage Class",
          "name": "storageClass",
          "type": "options",
          "options": [
            {
              "name": "Deep Archive",
              "value": "deepArchive"
            },
            {
              "name": "Glacier",
              "value": "glacier"
            },
            {
              "name": "Intelligent Tiering",
              "value": "intelligentTiering"
            },
            {
              "name": "One Zone IA",
              "value": "onezoneIA"
            },
            {
              "name": "Reduced Redundancy",
              "value": "RecudedRedundancy"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Standard IA",
              "value": "standardIA"
            }
          ],
          "default": "standard",
          "description": "Amazon S3 storage classes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Folder Key",
      "name": "folderKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "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": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "folder"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fetch Owner",
          "name": "fetchOwner",
          "type": "boolean",
          "default": false,
          "description": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true"
        },
        {
          "displayName": "Folder Key",
          "name": "folderKey",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "download",
      "options": [
        {
          "name": "Copy",
          "value": "copy",
          "description": "Copy a file",
          "action": "Copy a file"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a file",
          "action": "Delete a file"
        },
        {
          "name": "Download",
          "value": "download",
          "description": "Download a file",
          "action": "Download a file"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many files",
          "action": "Get many files"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload a file",
          "action": "Upload a file"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Source Path",
      "name": "sourcePath",
      "type": "string",
      "default": "",
      "description": "The name of the source bucket should start with (/) and key name of the source object, separated by a slash (/)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "copy"
          ]
        }
      }
    },
    {
      "displayName": "Destination Path",
      "name": "destinationPath",
      "type": "string",
      "default": "",
      "description": "The name of the destination bucket and key name of the destination object, separated by a slash (/)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "copy"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "ACL",
          "name": "acl",
          "type": "options",
          "options": [
            {
              "name": "Authenticated Read",
              "value": "authenticatedRead"
            },
            {
              "name": "AWS Exec Read",
              "value": "awsExecRead"
            },
            {
              "name": "Bucket Owner Full Control",
              "value": "bucketOwnerFullControl"
            },
            {
              "name": "Bucket Owner Read",
              "value": "bucketOwnerRead"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Public Read",
              "value": "publicRead"
            },
            {
              "name": "Public Read Write",
              "value": "publicReadWrite"
            }
          ],
          "default": "private",
          "description": "The canned ACL to apply to the object"
        },
        {
          "displayName": "Grant Full Control",
          "name": "grantFullControl",
          "type": "boolean",
          "default": false,
          "description": "Whether to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object"
        },
        {
          "displayName": "Grant Read",
          "name": "grantRead",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object data and its metadata"
        },
        {
          "displayName": "Grant Read ACP",
          "name": "grantReadAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object ACL"
        },
        {
          "displayName": "Grant Write ACP",
          "name": "grantWriteAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to write the ACL for the applicable object"
        },
        {
          "displayName": "Lock Legal Hold",
          "name": "lockLegalHold",
          "type": "boolean",
          "default": false,
          "description": "Whether a legal hold will be applied to this object"
        },
        {
          "displayName": "Lock Mode",
          "name": "lockMode",
          "type": "options",
          "options": [
            {
              "name": "Governance",
              "value": "governance"
            },
            {
              "name": "Compliance",
              "value": "compliance"
            }
          ],
          "default": "",
          "description": "The Object Lock mode that you want to apply to this object"
        },
        {
          "displayName": "Lock Retain Until Date",
          "name": "lockRetainUntilDate",
          "type": "dateTime",
          "default": "",
          "description": "The date and time when you want this object's Object Lock to expire"
        },
        {
          "displayName": "Metadata Directive",
          "name": "metadataDirective",
          "type": "options",
          "options": [
            {
              "name": "Copy",
              "value": "copy"
            },
            {
              "name": "Replace",
              "value": "replace"
            }
          ],
          "default": "",
          "description": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Server Side Encryption",
          "name": "serverSideEncryption",
          "type": "options",
          "options": [
            {
              "name": "AES256",
              "value": "AES256"
            },
            {
              "name": "AWS:KMS",
              "value": "aws:kms"
            }
          ],
          "default": "",
          "description": "The server-side encryption algorithm used when storing this object in Amazon S3"
        },
        {
          "displayName": "Server Side Encryption Context",
          "name": "serverSideEncryptionContext",
          "type": "string",
          "default": "",
          "description": "Specifies the AWS KMS Encryption Context to use for object encryption"
        },
        {
          "displayName": "Server Side Encryption AWS KMS Key ID",
          "name": "encryptionAwsKmsKeyId",
          "type": "string",
          "default": "",
          "description": "If x-amz-server-side-encryption is present and has the value of aws:kms"
        },
        {
          "displayName": "Server Side Encryption Customer Algorithm",
          "name": "serversideEncryptionCustomerAlgorithm",
          "type": "string",
          "default": "",
          "description": "Specifies the algorithm to use to when encrypting the object (for example, AES256)"
        },
        {
          "displayName": "Server Side Encryption Customer Key",
          "name": "serversideEncryptionCustomerKey",
          "type": "string",
          "default": "",
          "description": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data"
        },
        {
          "displayName": "Server Side Encryption Customer Key MD5",
          "name": "serversideEncryptionCustomerKeyMD5",
          "type": "string",
          "default": "",
          "description": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321"
        },
        {
          "displayName": "Storage Class",
          "name": "storageClass",
          "type": "options",
          "options": [
            {
              "name": "Deep Archive",
              "value": "deepArchive"
            },
            {
              "name": "Glacier",
              "value": "glacier"
            },
            {
              "name": "Intelligent Tiering",
              "value": "intelligentTiering"
            },
            {
              "name": "One Zone IA",
              "value": "onezoneIA"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Standard IA",
              "value": "standardIA"
            }
          ],
          "default": "standard",
          "description": "Amazon S3 storage classes"
        },
        {
          "displayName": "Tagging Directive",
          "name": "taggingDirective",
          "type": "options",
          "options": [
            {
              "name": "Copy",
              "value": "copy"
            },
            {
              "name": "Replace",
              "value": "replace"
            }
          ],
          "default": "",
          "description": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "copy"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "If not set the binary data filename will be used",
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ],
          "binaryData": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Binary File",
      "name": "binaryData",
      "type": "boolean",
      "default": true,
      "description": "Whether the data to upload should be taken from binary field",
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File Content",
      "name": "fileContent",
      "type": "string",
      "default": "",
      "description": "The text content of the file to upload",
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ],
          "binaryData": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "ACL",
          "name": "acl",
          "type": "options",
          "options": [
            {
              "name": "Authenticated Read",
              "value": "authenticatedRead"
            },
            {
              "name": "AWS Exec Read",
              "value": "awsExecRead"
            },
            {
              "name": "Bucket Owner Full Control",
              "value": "bucketOwnerFullControl"
            },
            {
              "name": "Bucket Owner Read",
              "value": "bucketOwnerRead"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Public Read",
              "value": "publicRead"
            },
            {
              "name": "Public Read Write",
              "value": "publicReadWrite"
            }
          ],
          "default": "private",
          "description": "The canned ACL to apply to the object"
        },
        {
          "displayName": "Grant Full Control",
          "name": "grantFullControl",
          "type": "boolean",
          "default": false,
          "description": "Whether to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object"
        },
        {
          "displayName": "Grant Read",
          "name": "grantRead",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object data and its metadata"
        },
        {
          "displayName": "Grant Read ACP",
          "name": "grantReadAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object ACL"
        },
        {
          "displayName": "Grant Write ACP",
          "name": "grantWriteAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to write the ACL for the applicable object"
        },
        {
          "displayName": "Lock Legal Hold",
          "name": "lockLegalHold",
          "type": "boolean",
          "default": false,
          "description": "Whether a legal hold will be applied to this object"
        },
        {
          "displayName": "Lock Mode",
          "name": "lockMode",
          "type": "options",
          "options": [
            {
              "name": "Governance",
              "value": "governance"
            },
            {
              "name": "Compliance",
              "value": "compliance"
            }
          ],
          "default": "",
          "description": "The Object Lock mode that you want to apply to this object"
        },
        {
          "displayName": "Lock Retain Until Date",
          "name": "lockRetainUntilDate",
          "type": "dateTime",
          "default": "",
          "description": "The date and time when you want this object's Object Lock to expire"
        },
        {
          "displayName": "Parent Folder Key",
          "name": "parentFolderKey",
          "type": "string",
          "default": "",
          "description": "Parent folder you want to create the file in"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Server Side Encryption",
          "name": "serverSideEncryption",
          "type": "options",
          "options": [
            {
              "name": "AES256",
              "value": "AES256"
            },
            {
              "name": "AWS:KMS",
              "value": "aws:kms"
            }
          ],
          "default": "",
          "description": "The server-side encryption algorithm used when storing this object in Amazon S3"
        },
        {
          "displayName": "Server Side Encryption Context",
          "name": "serverSideEncryptionContext",
          "type": "string",
          "default": "",
          "description": "Specifies the AWS KMS Encryption Context to use for object encryption"
        },
        {
          "displayName": "Server Side Encryption AWS KMS Key ID",
          "name": "encryptionAwsKmsKeyId",
          "type": "string",
          "default": "",
          "description": "If x-amz-server-side-encryption is present and has the value of aws:kms"
        },
        {
          "displayName": "Server Side Encryption Customer Algorithm",
          "name": "serversideEncryptionCustomerAlgorithm",
          "type": "string",
          "default": "",
          "description": "Specifies the algorithm to use to when encrypting the object (for example, AES256)"
        },
        {
          "displayName": "Server Side Encryption Customer Key",
          "name": "serversideEncryptionCustomerKey",
          "type": "string",
          "default": "",
          "description": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data"
        },
        {
          "displayName": "Server Side Encryption Customer Key MD5",
          "name": "serversideEncryptionCustomerKeyMD5",
          "type": "string",
          "default": "",
          "description": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321"
        },
        {
          "displayName": "Storage Class",
          "name": "storageClass",
          "type": "options",
          "options": [
            {
              "name": "Deep Archive",
              "value": "deepArchive"
            },
            {
              "name": "Glacier",
              "value": "glacier"
            },
            {
              "name": "Intelligent Tiering",
              "value": "intelligentTiering"
            },
            {
              "name": "One Zone IA",
              "value": "onezoneIA"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Standard IA",
              "value": "standardIA"
            }
          ],
          "default": "standard",
          "description": "Amazon S3 storage classes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Tags",
      "name": "tagsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "options": [
        {
          "name": "tagsValues",
          "displayName": "Tag",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "File Key",
      "name": "fileKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "File Key",
      "name": "fileKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Version ID",
          "name": "versionId",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "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": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fetch Owner",
          "name": "fetchOwner",
          "type": "boolean",
          "default": false,
          "description": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true"
        },
        {
          "displayName": "Folder Key",
          "name": "folderKey",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a bucket"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a bucket"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many buckets"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search within a bucket"
    }
  ]


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS SES node documentation
  description: Learn how to use the AWS SES node in n8n. Follow technical documentation to integrate AWS SES node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS SES node

  Use the AWS SES node to automate work in AWS SES, and integrate AWS SES with other applications. n8n has built-in support for a wide range of AWS SES features, including creating, getting, deleting, sending, updating, and adding templates and emails.

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

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

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

  ## Operations

  * Custom Verification Email
      * Create a new custom verification email template
      * Delete an existing custom verification email template
      * Get the custom email verification template
      * Get all the existing custom verification email templates for your account
      * Add an email address to the list of identities
      * Update an existing custom verification email template.
  * Email
      * Send
      * Send Template
  * Template
      * Create a template
      * Delete a template
      * Get a template
      * Get all templates
      * Update a template

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Custom Verification Email",
          "value": "customVerificationEmail"
        },
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Template",
          "value": "template"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new custom verification email template",
          "action": "Create a custom verification email"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an existing custom verification email template",
          "action": "Delete a custom verification email"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get the custom email verification template",
          "action": "Get a custom verification email"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many of the existing custom verification email templates for your account",
          "action": "Get many custom verifications"
        },
        {
          "name": "Send",
          "value": "send",
          "description": "Add an email address to the list of identities",
          "action": "Send a custom verification email"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an existing custom verification email template",
          "action": "Update a custom verification email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From Email",
      "name": "fromEmailAddress",
      "type": "string",
      "default": "",
      "description": "The email address that the custom verification email is sent from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Template Name",
      "name": "templateName",
      "type": "string",
      "default": "",
      "description": "The name of the custom verification email template",
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Template Content",
      "name": "templateContent",
      "type": "string",
      "default": "",
      "description": "The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML",
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Template Subject",
      "name": "templateSubject",
      "type": "string",
      "default": "",
      "description": "The subject line of the custom verification email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Success Redirection URL",
      "name": "successRedirectionURL",
      "type": "string",
      "default": "",
      "description": "The URL that the recipient of the verification email is sent to if his or her address is successfully verified",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Failure Redirection URL",
      "name": "failureRedirectionURL",
      "type": "string",
      "default": "",
      "description": "The URL that the recipient of the verification email is sent to if his or her address is not successfully verified",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address to verify",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Template Name",
      "name": "templateName",
      "type": "string",
      "default": "",
      "description": "The name of the custom verification email template to use when sending the verification email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Configuration Set Name",
          "name": "configurationSetName",
          "type": "string",
          "description": "Name of a configuration set to use when sending the verification email",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Template Name",
      "name": "templateName",
      "type": "string",
      "default": "",
      "description": "The name of the custom verification email template",
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "update",
            "delete",
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Failure Redirection URL",
          "name": "failureRedirectionURL",
          "type": "string",
          "description": "The URL that the recipient of the verification email is sent to if his or her address is not successfully verified",
          "default": ""
        },
        {
          "displayName": "From Email",
          "name": "fromEmailAddress",
          "type": "string",
          "description": "The email address that the custom verification email is sent from",
          "default": ""
        },
        {
          "displayName": "Success Redirection URL",
          "name": "successRedirectionURL",
          "type": "string",
          "description": "The URL that the recipient of the verification email is sent to if his or her address is successfully verified",
          "default": ""
        },
        {
          "displayName": "Template Content",
          "name": "templateContent",
          "type": "string",
          "description": "The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML",
          "default": ""
        },
        {
          "displayName": "Template Subject",
          "name": "templateSubject",
          "type": "string",
          "default": "",
          "description": "The subject line of the custom verification email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 20,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customVerificationEmail"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "action": "Send an email"
        },
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "action": "Send an email based on a template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Is Body HTML",
      "name": "isBodyHtml",
      "type": "boolean",
      "default": false,
      "description": "Whether body is HTML or simple text",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "body",
      "type": "string",
      "default": "",
      "description": "The message to be sent",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To Addresses",
      "name": "toAddresses",
      "type": "string",
      "default": [],
      "description": "Email addresses of the recipients",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add To Email"
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateName",
      "type": "options",
      "default": "",
      "description": "The ARN of the template to use when sending this email. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Addresses",
      "name": "toAddresses",
      "type": "string",
      "default": [],
      "description": "Email addresses of the recipients",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add To Email"
      }
    },
    {
      "displayName": "Template Data",
      "name": "templateDataUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Data",
          "name": "templateDataValues",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Addresses",
          "name": "bccAddresses",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Bcc Email"
          },
          "description": "Bcc Recipients of the email",
          "default": []
        },
        {
          "displayName": "Cc Addresses",
          "name": "ccAddresses",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Cc Email"
          },
          "description": "Cc recipients of the email",
          "default": []
        },
        {
          "displayName": "Configuration Set Name",
          "name": "configurationSetName",
          "type": "string",
          "description": "Name of the configuration set to use when you send an email using send",
          "default": ""
        },
        {
          "displayName": "Reply To Addresses",
          "name": "replyToAddresses",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Reply To Email"
          },
          "placeholder": "Add Reply Address",
          "description": "Reply-to email address(es) for the message",
          "default": []
        },
        {
          "displayName": "Return Path",
          "name": "returnPath",
          "type": "string",
          "description": "Email address that bounces and complaints will be forwarded to when feedback forwarding is enabled",
          "default": ""
        },
        {
          "displayName": "Return Path ARN",
          "name": "returnPathArn",
          "type": "string",
          "default": "",
          "description": "This parameter is used only for sending authorization"
        },
        {
          "displayName": "Source ARN",
          "name": "sourceArn",
          "type": "string",
          "description": "This parameter is used only for sending authorization",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a template",
          "action": "Create a template"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a template",
          "action": "Delete a template"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a template",
          "action": "Get a template"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many templates",
          "action": "Get many templates"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a template",
          "action": "Update a template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template Name",
      "name": "templateName",
      "type": "string",
      "default": "",
      "description": "The name of the template",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "update",
            "create",
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subject Part",
      "name": "subjectPart",
      "type": "string",
      "default": "",
      "description": "The subject line of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Html Part",
      "name": "htmlPart",
      "type": "string",
      "default": "",
      "description": "The HTML body of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Text Part",
          "name": "textPart",
          "type": "string",
          "description": "The email body that will be visible to recipients whose email clients do not display HTML",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Text Part",
          "name": "textPart",
          "type": "string",
          "description": "The email body that will be visible to recipients whose email clients do not display HTML",
          "default": ""
        },
        {
          "displayName": "Subject Part",
          "name": "subjectPart",
          "type": "string",
          "description": "The subject line of the email",
          "default": ""
        },
        {
          "displayName": "Html Part",
          "name": "htmlPart",
          "type": "string",
          "description": "The HTML body of the email",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 20,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new custom verification email template"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an existing custom verification email template"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get the custom email verification template"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many of the existing custom verification email templates for your account"
    },
    {
      "operation": "send",
      "name": "Send",
      "description": "Add an email address to the list of identities"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an existing custom verification email template"
    }
  ]


node_type: nodes-base.awsSqs
package_name: n8n-nodes-base
display_name: AWS SQS
description: Sends messages to AWS SQS
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "aws",
  "required": true
  }
  ]

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS SQS node documentation
  description: Learn how to use the AWS SQS node in n8n. Follow technical documentation to integrate AWS SQS node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS SQS node

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

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

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

  ## Operations

  * Send a message to a queue.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "sendMessage",
      "options": [
        {
          "name": "Send Message",
          "value": "sendMessage",
          "description": "Send a message to a queue",
          "action": "Send a message to a queue"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Queue Name or ID",
      "name": "queue",
      "type": "options",
      "default": "",
      "description": "Queue to send a message to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getQueues"
      }
    },
    {
      "displayName": "Queue Type",
      "name": "queueType",
      "type": "options",
      "default": "standard",
      "options": [
        {
          "name": "FIFO",
          "value": "fifo",
          "description": "FIFO SQS queue"
        },
        {
          "name": "Standard",
          "value": "standard",
          "description": "Standard SQS queue"
        }
      ]
    },
    {
      "displayName": "Send Input Data",
      "name": "sendInputData",
      "type": "boolean",
      "default": true,
      "description": "Whether to send the data the node receives as JSON to SQS"
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Message to send to the queue",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ],
          "sendInputData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Message Group ID",
      "name": "messageGroupId",
      "type": "string",
      "default": "",
      "description": "Tag that specifies that a message belongs to a specific message group. Applies only to FIFO (first-in-first-out) queues.",
      "required": true,
      "displayOptions": {
        "show": {
          "queueType": [
            "fifo"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delay Seconds",
          "name": "delaySeconds",
          "type": "number",
          "displayOptions": {
            "show": {
              "/queueType": [
                "standard"
              ]
            }
          },
          "description": "How long, in seconds, to delay a message for",
          "default": 0,
          "typeOptions": {
            "minValue": 0,
            "maxValue": 900
          }
        },
        {
          "displayName": "Message Attributes",
          "name": "messageAttributes",
          "placeholder": "Add Attribute",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Attributes to set",
          "default": {},
          "options": [
            {
              "name": "binary",
              "displayName": "Binary",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the attribute"
                },
                {
                  "displayName": "Property Name",
                  "name": "dataPropertyName",
                  "type": "string",
                  "default": "data",
                  "description": "Name of the binary property which contains the data for the message attribute"
                }
              ]
            },
            {
              "name": "number",
              "displayName": "Number",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the attribute"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "number",
                  "default": 0,
                  "description": "Number value of the attribute"
                }
              ]
            },
            {
              "name": "string",
              "displayName": "String",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the attribute"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "String value of attribute"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Message Deduplication ID",
          "name": "messageDeduplicationId",
          "type": "string",
          "default": "",
          "description": "Token used for deduplication of sent messages. Applies only to FIFO (first-in-first-out) queues.",
          "displayOptions": {
            "show": {
              "/queueType": [
                "fifo"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "sendMessage",
      "name": "Send Message",
      "description": "Send a message to a queue"
    }
  ]


node_type: nodes-base.awsTextract
package_name: n8n-nodes-base
display_name: AWS Textract
description: Sends data to Amazon Textract
category: output
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "analyzeExpense",
  "name": "Analyze Receipt or Invoice"
  }
  ]

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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Textract node documentation
  description: Learn how to use the AWS Textract node in n8n. Follow technical documentation to integrate AWS Textract node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Textract node

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

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

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

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

  ## Operations

  - Analyze Receipt or Invoice

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "analyzeExpense",
      "options": [
        {
          "name": "Analyze Receipt or Invoice",
          "value": "analyzeExpense"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Input Data Field Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "The name of the input field containing the binary file data to be uploaded. Supported file types: PNG, JPEG.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "analyzeExpense"
          ]
        }
      }
    },
    {
      "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": [
            "analyzeExpense"
          ]
        }
      }
    }
  ]


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

updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: AWS Transcribe node documentation
  description: Learn how to use the AWS Transcribe node in n8n. Follow technical documentation to integrate AWS Transcribe node into your workflows.
  contentType: [integration, reference]
  ---

  # AWS Transcribe node

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

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

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

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

  ## Operations

  **Transcription Job**

  - Create a transcription job
  - Delete a transcription job
  - Get a transcription job
  - Get all transcriptions job

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "transcriptionJob",
      "options": [
        {
          "name": "Transcription Job",
          "value": "transcriptionJob"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a transcription job",
          "action": "Create a transcription job"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a transcription job",
          "action": "Delete a transcription job"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a transcription job",
          "action": "Get a transcription job"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many transcription jobs",
          "action": "Get many transcription jobs"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Job Name",
      "name": "transcriptionJobName",
      "type": "string",
      "default": "",
      "description": "The name of the job",
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "create",
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Media File URI",
      "name": "mediaFileUri",
      "type": "string",
      "default": "",
      "description": "The S3 object location of the input media file",
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Detect Language",
      "name": "detectLanguage",
      "type": "boolean",
      "default": false,
      "description": "Whether to set this field to true to enable automatic language identification",
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Language",
      "name": "languageCode",
      "type": "options",
      "default": "en-US",
      "description": "Language used in the input media file",
      "options": [
        {
          "name": "American English",
          "value": "en-US"
        },
        {
          "name": "British English",
          "value": "en-GB"
        },
        {
          "name": "German",
          "value": "de-DE"
        },
        {
          "name": "Indian English",
          "value": "en-IN"
        },
        {
          "name": "Irish English",
          "value": "en-IE"
        },
        {
          "name": "Russian",
          "value": "ru-RU"
        },
        {
          "name": "Spanish",
          "value": "es-ES"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "create"
          ],
          "detectLanguage": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Channel Identification",
          "name": "channelIdentification",
          "type": "boolean",
          "default": false,
          "description": "Instructs Amazon Transcribe to process each audiochannel separately and then merge the transcription output of each channel into a single transcription. You can't set both Max Speaker Labels and Channel Identification in the same request. If you set both, your request returns a BadRequestException."
        },
        {
          "displayName": "Max Alternatives",
          "name": "maxAlternatives",
          "type": "number",
          "default": 2,
          "typeOptions": {
            "minValue": 2,
            "maxValue": 10
          },
          "description": "The number of alternative transcriptions that the service should return"
        },
        {
          "displayName": "Max Speaker Labels",
          "name": "maxSpeakerLabels",
          "type": "number",
          "default": 2,
          "typeOptions": {
            "minValue": 2,
            "maxValue": 10
          },
          "description": "The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker."
        },
        {
          "displayName": "Vocabulary Name",
          "name": "vocabularyName",
          "type": "string",
          "default": "",
          "description": "Name of vocabulary to use when processing the transcription job"
        },
        {
          "displayName": "Vocabulary Filter Name",
          "name": "vocabularyFilterName",
          "type": "string",
          "default": "",
          "description": "The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job."
        },
        {
          "displayName": "Vocabulary Filter Method",
          "name": "vocabularyFilterMethod",
          "type": "options",
          "options": [
            {
              "name": "Remove",
              "value": "remove"
            },
            {
              "name": "Mask",
              "value": "mask"
            },
            {
              "name": "Tag",
              "value": "tag"
            }
          ],
          "default": "remove",
          "description": "<p>Set to mask to remove filtered text from the transcript and replace it with three asterisks (\"***\") as placeholder text.</p><p>Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.</p>"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return Transcript",
      "name": "returnTranscript",
      "type": "boolean",
      "default": true,
      "description": "By default, the response only contains metadata about the transcript. Enable this option to retrieve the transcript instead.",
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "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": [
            "transcriptionJob"
          ],
          "operation": [
            "get"
          ],
          "returnTranscript": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 20,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Job Name Contains",
          "name": "jobNameContains",
          "type": "string",
          "description": "Return only transcription jobs whose name contains the specified string",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Completed",
              "value": "COMPLETED"
            },
            {
              "name": "Failed",
              "value": "FAILED"
            },
            {
              "name": "In Progress",
              "value": "IN_PROGRESS"
            },
            {
              "name": "Queued",
              "value": "QUEUED"
            }
          ],
          "description": "Return only transcription jobs with the specified status",
          "default": "COMPLETED"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transcriptionJob"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a transcription job"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a transcription job"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a transcription job"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many transcription jobs"
    }
  ]


node_type: nodes-base.bambooHr
package_name: n8n-nodes-base
display_name: BambooHR
description: Consume BambooHR API
category: transform
development_style: programmatic
version: 1
updated_at: 2025-06-24 11:07:34
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: BambooHR node documentation
  description: Learn how to use the BambooHR node in n8n. Follow technical documentation to integrate BambooHR node into your workflows.
  contentType: [integration, reference]
  ---

  # BambooHR node

  Use the BambooHR node to automate work in BambooHR, and integrate BambooHR with other applications. n8n has built-in support for a wide range of BambooHR features, including creating, deleting, downloading, and getting company reports, employee documents, and files.

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

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

  ## Operations

  * Company Report
      * Get a company report
  * Employee
      * Create an employee
      * Get an employee
      * Get all employees
      * Update an employee
  * Employee Document
      * Delete an employee document
      * Download an employee document
      * Get all employee document
      * Update an employee document
      * Upload an employee document
  * File
      * Delete a company file
      * Download a company file
      * Get all company files
      * Update a company file
      * Upload a company file

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "employee",
      "options": [
        {
          "name": "Company Report",
          "value": "companyReport"
        },
        {
          "name": "Employee",
          "value": "employee"
        },
        {
          "name": "Employee Document",
          "value": "employeeDocument"
        },
        {
          "name": "File",
          "value": "file"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an employee",
          "action": "Create an employee"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an employee",
          "action": "Get an employee"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many employees",
          "action": "Get many employees"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an employee",
          "action": "Update an employee"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Synced with Trax Payroll",
      "name": "synced",
      "type": "boolean",
      "default": false,
      "description": "Whether the employee to create was added to a pay schedule synced with Trax Payroll",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Address",
      "name": "address",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Address",
          "values": [
            {
              "displayName": "Line 1",
              "name": "address1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Line 2",
              "name": "address2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": "",
              "placeholder": "Florida",
              "description": "The full name of the state/province"
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": "",
              "placeholder": "United States",
              "description": "The name of the country. Must exist in the BambooHr country list."
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Date of Birth",
      "name": "dateOfBirth",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Department Name or ID",
      "name": "department",
      "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": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDepartments"
      }
    },
    {
      "displayName": "Division Name or ID",
      "name": "division",
      "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": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDivisions"
      }
    },
    {
      "displayName": "Employee Number",
      "name": "employeeNumber",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "FLSA Overtime Status",
      "name": "exempt",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Exempt",
          "value": "exempt"
        },
        {
          "name": "Non-Exempt",
          "value": "non-exempt"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Gender",
      "name": "gender",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Female",
          "value": "female"
        },
        {
          "name": "Male",
          "value": "male"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Hire Date",
      "name": "hireDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Location Name or ID",
      "name": "location",
      "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": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getEmployeeLocations"
      }
    },
    {
      "displayName": "Marital Status",
      "name": "maritalStatus",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Single",
          "value": "single"
        },
        {
          "name": "Married",
          "value": "married"
        },
        {
          "name": "Domestic Partnership",
          "value": "domesticPartnership"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Mobile Phone",
      "name": "mobilePhone",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Per",
      "name": "paidPer",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Hour",
          "value": "hour"
        },
        {
          "name": "Day",
          "value": "day"
        },
        {
          "name": "Week",
          "value": "week"
        },
        {
          "name": "Month",
          "value": "month"
        },
        {
          "name": "Quater",
          "value": "quater"
        },
        {
          "name": "Year",
          "value": "year"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Rate",
      "name": "payRate",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Pay Rate",
          "values": [
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "placeholder": "20.00"
            },
            {
              "displayName": "Currency",
              "name": "currency",
              "type": "string",
              "default": "",
              "placeholder": "USD"
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Pay Type",
      "name": "payType",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Commission",
          "value": "commission"
        },
        {
          "name": "Contract",
          "value": "contract"
        },
        {
          "name": "Daily",
          "value": "daily"
        },
        {
          "name": "Exception Hourly",
          "value": "exceptionHourly"
        },
        {
          "name": "Hourly",
          "value": "hourly"
        },
        {
          "name": "Monthly",
          "value": "monthly"
        },
        {
          "name": "Piece Rate",
          "value": "pieceRate"
        },
        {
          "name": "Pro Rata",
          "value": "proRata"
        },
        {
          "name": "Salary",
          "value": "salary"
        },
        {
          "name": "Weekly",
          "value": "weekly"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Preferred Name",
      "name": "preferredName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Social Security Number",
      "name": "ssn",
      "type": "string",
      "default": "",
      "description": "A standard United States Social Security number, with dashes",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": "",
                  "placeholder": "Florida",
                  "description": "The full name of the state/province"
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "placeholder": "United States",
                  "description": "The name of the country. Must exist in the BambooHr country list."
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Date of Birth",
          "name": "dateOfBirth",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Department Name or ID",
          "name": "department",
          "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": "getDepartments"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Division Name or ID",
          "name": "division",
          "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": "getDivisions"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Employee Number",
          "name": "employeeNumber",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "FLSA Overtime Status",
          "name": "exempt",
          "type": "options",
          "options": [
            {
              "name": "Exempt",
              "value": "exempt"
            },
            {
              "name": "Non-Exempt",
              "value": "non-exempt"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Hire Date",
          "name": "hireDate",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Location Name or ID",
          "name": "location",
          "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": "getEmployeeLocations"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Marital Status",
          "name": "maritalStatus",
          "type": "options",
          "options": [
            {
              "name": "Single",
              "value": "single"
            },
            {
              "name": "Married",
              "value": "married"
            },
            {
              "name": "Domestic Partnership",
              "value": "domesticPartnership"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobilePhone",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Per",
          "name": "paidPer",
          "type": "options",
          "options": [
            {
              "name": "Hour",
              "value": "hour"
            },
            {
              "name": "Day",
              "value": "day"
            },
            {
              "name": "Week",
              "value": "week"
            },
            {
              "name": "Month",
              "value": "month"
            },
            {
              "name": "Quater",
              "value": "quater"
            },
            {
              "name": "Year",
              "value": "year"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Rate",
          "name": "payRate",
          "placeholder": "Add Pay Rate",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Pay Rate",
              "values": [
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "20.00"
                },
                {
                  "displayName": "Currency",
                  "name": "currency",
                  "type": "string",
                  "default": "",
                  "placeholder": "USD"
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Type",
          "name": "payType",
          "type": "options",
          "options": [
            {
              "name": "Commission",
              "value": "commission"
            },
            {
              "name": "Contract",
              "value": "contract"
            },
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Exception Hourly",
              "value": "exceptionHourly"
            },
            {
              "name": "Hourly",
              "value": "hourly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            },
            {
              "name": "Piece Rate",
              "value": "pieceRate"
            },
            {
              "name": "Pro Rata",
              "value": "proRata"
            },
            {
              "name": "Salary",
              "value": "salary"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Preferred Name",
          "name": "preferredName",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Social Security Number",
          "name": "ssn",
          "type": "string",
          "default": "",
          "placeholder": "123-45-6789",
          "description": "A standard United States Social Security number, with dashes",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Work Email",
          "name": "workEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Phone",
          "name": "workPhone",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Field Names or IDs",
          "name": "fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getEmployeeFields"
          },
          "default": [
            "all"
          ],
          "description": "Set of fields to get from employee data. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "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": [
            "employee"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Synced with Trax Payroll",
      "name": "synced",
      "type": "boolean",
      "default": false,
      "description": "Whether the employee to create was added to a pay schedule synced with Trax Payroll",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Address",
      "name": "addasasress",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Address",
          "values": [
            {
              "displayName": "Line 1",
              "name": "address1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Line 2",
              "name": "address2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": "",
              "placeholder": "Florida",
              "description": "The full name of the state/province"
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": "",
              "placeholder": "United States",
              "description": "The name of the country. Must exist in the BambooHr country list."
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Date of Birth",
      "name": "dateOfBirth",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Department Name or ID",
      "name": "department",
      "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": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDepartments"
      }
    },
    {
      "displayName": "Division Name or ID",
      "name": "division",
      "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": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDivisions"
      }
    },
    {
      "displayName": "Employee Number",
      "name": "employeeNumber",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "FLSA Overtime Status",
      "name": "exempt",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Exempt",
          "value": "exempt"
        },
        {
          "name": "Non-Exempt",
          "value": "non-exempt"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Gender",
      "name": "gender",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Female",
          "value": "female"
        },
        {
          "name": "Male",
          "value": "male"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Hire Date",
      "name": "hireDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Location Name or ID",
      "name": "location",
      "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": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getEmployeeLocations"
      }
    },
    {
      "displayName": "Marital Status",
      "name": "maritalStatus",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Single",
          "value": "single"
        },
        {
          "name": "Married",
          "value": "married"
        },
        {
          "name": "Domestic Partnership",
          "value": "domesticPartnership"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Mobile Phone",
      "name": "mobilePhone",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Per",
      "name": "paidPer",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Hour",
          "value": "hour"
        },
        {
          "name": "Day",
          "value": "day"
        },
        {
          "name": "Week",
          "value": "week"
        },
        {
          "name": "Month",
          "value": "month"
        },
        {
          "name": "Quater",
          "value": "quater"
        },
        {
          "name": "Year",
          "value": "year"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Rate",
      "name": "payRate",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Pay Rate",
          "values": [
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "placeholder": "20.00"
            },
            {
              "displayName": "Currency",
              "name": "currency",
              "type": "string",
              "default": "",
              "placeholder": "USD"
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Pay Type",
      "name": "payType",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Commission",
          "value": "commission"
        },
        {
          "name": "Contract",
          "value": "contract"
        },
        {
          "name": "Daily",
          "value": "daily"
        },
        {
          "name": "Exception Hourly",
          "value": "exceptionHourly"
        },
        {
          "name": "Hourly",
          "value": "hourly"
        },
        {
          "name": "Monthly",
          "value": "monthly"
        },
        {
          "name": "Piece Rate",
          "value": "pieceRate"
        },
        {
          "name": "Pro Rata",
          "value": "proRata"
        },
        {
          "name": "Salary",
          "value": "salary"
        },
        {
          "name": "Weekly",
          "value": "weekly"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Preferred Name",
      "name": "preferredName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Social Security Number",
      "name": "ssn",
      "type": "string",
      "default": "",
      "description": "A standard United States Social Security number, with dashes",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addasasress",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": "",
                  "placeholder": "Florida",
                  "description": "The full name of the state/province"
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "placeholder": "United States",
                  "description": "The name of the country. Must exist in the BambooHr country list."
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Date of Birth",
          "name": "dateOfBirth",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Department Name or ID",
          "name": "department",
          "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": "getDepartments"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Division Name or ID",
          "name": "division",
          "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": "getDivisions"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Employee Number",
          "name": "employeeNumber",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "FLSA Overtime Status",
          "name": "exempt",
          "type": "options",
          "options": [
            {
              "name": "Exempt",
              "value": "exempt"
            },
            {
              "name": "Non-Exempt",
              "value": "non-exempt"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Hire Date",
          "name": "hireDate",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Location Name or ID",
          "name": "location",
          "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": "getEmployeeLocations"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Marital Status",
          "name": "maritalStatus",
          "type": "options",
          "options": [
            {
              "name": "Single",
              "value": "single"
            },
            {
              "name": "Married",
              "value": "married"
            },
            {
              "name": "Domestic Partnership",
              "value": "domesticPartnership"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobilePhone",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Per",
          "name": "paidPer",
          "type": "options",
          "options": [
            {
              "name": "Hour",
              "value": "hour"
            },
            {
              "name": "Day",
              "value": "day"
            },
            {
              "name": "Week",
              "value": "week"
            },
            {
              "name": "Month",
              "value": "month"
            },
            {
              "name": "Quater",
              "value": "quater"
            },
            {
              "name": "Year",
              "value": "year"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Rate",
          "name": "payRate",
          "placeholder": "Add Pay Rate",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Pay Rate",
              "values": [
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "20.00"
                },
                {
                  "displayName": "Currency",
                  "name": "currency",
                  "type": "string",
                  "default": "",
                  "placeholder": "USD"
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Type",
          "name": "payType",
          "type": "options",
          "options": [
            {
              "name": "Commission",
              "value": "commission"
            },
            {
              "name": "Contract",
              "value": "contract"
            },
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Exception Hourly",
              "value": "exceptionHourly"
            },
            {
              "name": "Hourly",
              "value": "hourly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            },
            {
              "name": "Piece Rate",
              "value": "pieceRate"
            },
            {
              "name": "Pro Rata",
              "value": "proRata"
            },
            {
              "name": "Salary",
              "value": "salary"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Preferred Name",
          "name": "preferredName",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Social Security Number",
          "name": "ssn",
          "type": "string",
          "default": "",
          "placeholder": "123-45-6789",
          "description": "A standard United States Social Security number, with dashes",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Work Email",
          "name": "workEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Phone",
          "name": "workPhone",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "delete",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an employee document",
          "action": "Delete an employee document"
        },
        {
          "name": "Download",
          "value": "download",
          "description": "Download an employee document",
          "action": "Download an employee document"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many employee documents",
          "action": "Get many employee documents"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an employee document",
          "action": "Update an employee document"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload an employee document",
          "action": "Upload an employee document"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employeeDocument"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "ID of the employee",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the employee file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "ID of the employee",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the employee file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "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": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "employeeDocument"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Employee Document Category Name or ID",
          "name": "categoryId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEmployeeDocumentCategories",
            "loadOptionsDependsOn": [
              "employeeId"
            ]
          },
          "default": "",
          "description": "ID of the new category of the file. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "New name of the file"
        },
        {
          "displayName": "Share with Employee",
          "name": "shareWithEmployee",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "ID of the employee",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee Document Category ID",
      "name": "categoryId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Input Data Field Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "The name of the input field containing the binary file data to be uploaded. Supported file types: PNG, JPEG.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Share with Employee",
          "name": "share",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "delete",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company file",
          "action": "Delete a file"
        },
        {
          "name": "Download",
          "value": "download",
          "description": "Download a company file",
          "action": "Download a file"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many company files",
          "action": "Get many files"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company file",
          "action": "Update a file"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload a company file",
          "action": "Upload a file"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "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": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category Name or ID",
          "name": "categoryId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyFileCategories"
          },
          "default": "",
          "description": "Move the file to a different category. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "New name of the file"
        },
        {
          "displayName": "Share with Employee",
          "name": "shareWithEmployee",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Input Data Field Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "The name of the input field containing the binary file data to be uploaded. Supported file types: PNG, JPEG.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Category Name or ID",
      "name": "categoryId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCompanyFileCategories"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Share with Employee",
          "name": "share",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a company report",
          "action": "Get a company report"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "companyReport"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Report ID",
      "name": "reportId",
      "type": "string",
      "default": "",
      "description": "ID of the report. You can get the report number by hovering over the report name on the reports page and grabbing the ID.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        }
      }
    },
    {
      "displayName": "Format",
      "name": "format",
      "type": "options",
      "default": "JSON",
      "description": "The output format for the report",
      "options": [
        {
          "name": "CSV",
          "value": "CSV"
        },
        {
          "name": "JSON",
          "value": "JSON"
        },
        {
          "name": "PDF",
          "value": "PDF"
        },
        {
          "name": "XLS",
          "value": "XLS"
        },
        {
          "name": "XML",
          "value": "XML"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        },
        "hide": {
          "format": [
            "JSON"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Duplicate Field Filtering",
          "name": "fd",
          "type": "boolean",
          "default": true,
          "description": "Whether to apply the standard duplicate field filtering or not"
        },
        {
          "displayName": "Only Current",
          "name": "onlyCurrent",
          "type": "boolean",
          "default": true,
          "description": "Whether to hide future dated values from the history table fields or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an employee"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an employee"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many employees"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an employee"
    }
  ]

credentials_required:
  [
    {
      "name": "bambooHrApi",
      "required": true,
      "testedBy": "bambooHrApiCredentialTest"
    }
  ]


