# nodes

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

outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Wise node documentation
  description: Learn how to use the Wise node in n8n. Follow technical documentation to integrate Wise node into your workflows.
  contentType: [integration, reference]
  ---

  # Wise node

  Use the Wise node to automate work in Wise, and integrate Wise with other applications. n8n has built-in support for a wide range of Wise features, including getting profiles, exchange rates, and recipients. 

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

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

  ## Operations

  * Account
      * Retrieve balances for all account currencies of this user.
      * Retrieve currencies in the borderless account of this user.
      * Retrieve the statement for the borderless account of this user.
  * Exchange Rate
      * Get
  * Profile
      * Get
      * Get All
  * Recipient
      * Get All
  * Quote
      * Create
      * Get
  * Transfer
      * Create
      * Delete
      * Execute
      * Get
      * Get All

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "account",
      "options": [
        {
          "name": "Account",
          "value": "account"
        },
        {
          "name": "Exchange Rate",
          "value": "exchangeRate"
        },
        {
          "name": "Profile",
          "value": "profile"
        },
        {
          "name": "Quote",
          "value": "quote"
        },
        {
          "name": "Recipient",
          "value": "recipient"
        },
        {
          "name": "Transfer",
          "value": "transfer"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getBalances",
      "options": [
        {
          "name": "Get Balances",
          "value": "getBalances",
          "description": "Retrieve balances for all account currencies of this user",
          "action": "Get balances"
        },
        {
          "name": "Get Currencies",
          "value": "getCurrencies",
          "description": "Retrieve currencies in the borderless account of this user",
          "action": "Get currencies"
        },
        {
          "name": "Get Statement",
          "value": "getStatement",
          "description": "Retrieve the statement for the borderless account of this user",
          "action": "Get a statement"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile to retrieve the balance of. 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": [
            "account"
          ],
          "operation": [
            "getBalances"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile whose account to retrieve the statement of. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ],
          "operation": [
            "getStatement"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "displayName": "Borderless Account Name or ID",
      "name": "borderlessAccountId",
      "type": "options",
      "default": [],
      "description": "ID of the borderless account to retrieve the statement of. 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": [
            "account"
          ],
          "operation": [
            "getStatement"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getBorderlessAccounts",
        "loadOptionsDependsOn": [
          "profileId"
        ]
      }
    },
    {
      "displayName": "Currency",
      "name": "currency",
      "type": "string",
      "default": "",
      "description": "Code of the currency of the borderless account to retrieve the statement of",
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ],
          "operation": [
            "getStatement"
          ]
        }
      }
    },
    {
      "displayName": "Format",
      "name": "format",
      "type": "options",
      "default": "json",
      "description": "File format to retrieve the statement in",
      "options": [
        {
          "name": "JSON",
          "value": "json"
        },
        {
          "name": "CSV",
          "value": "csv"
        },
        {
          "name": "PDF",
          "value": "pdf"
        },
        {
          "name": "XML (CAMT.053)",
          "value": "xml"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ],
          "operation": [
            "getStatement"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryProperty",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ],
          "operation": [
            "getStatement"
          ],
          "format": [
            "csv",
            "pdf",
            "xml"
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the file that will be downloaded",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ],
          "operation": [
            "getStatement"
          ],
          "format": [
            "csv",
            "pdf",
            "xml"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Line Style",
          "name": "lineStyle",
          "type": "options",
          "default": "COMPACT",
          "description": "Line style to retrieve the statement in",
          "options": [
            {
              "name": "Compact",
              "value": "COMPACT",
              "description": "Single line per transaction"
            },
            {
              "name": "Flat",
              "value": "FLAT",
              "description": "Separate lines for transaction fees"
            }
          ]
        },
        {
          "displayName": "Range",
          "name": "range",
          "type": "fixedCollection",
          "placeholder": "Add Range",
          "default": {},
          "options": [
            {
              "displayName": "Range Properties",
              "name": "rangeProperties",
              "values": [
                {
                  "displayName": "Range Start",
                  "name": "intervalStart",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "Range End",
                  "name": "intervalEnd",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ],
          "operation": [
            "getStatement"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an exchange rate"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "exchangeRate"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Source Currency",
      "name": "source",
      "type": "string",
      "default": "",
      "description": "Code of the source currency to retrieve the exchange rate for",
      "displayOptions": {
        "show": {
          "resource": [
            "exchangeRate"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Target Currency",
      "name": "target",
      "type": "string",
      "default": "",
      "description": "Code of the target currency to retrieve the exchange rate for",
      "displayOptions": {
        "show": {
          "resource": [
            "exchangeRate"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Interval",
          "name": "interval",
          "type": "options",
          "default": "day",
          "options": [
            {
              "name": "Day",
              "value": "day"
            },
            {
              "name": "Hour",
              "value": "hour"
            },
            {
              "name": "Minute",
              "value": "minute"
            }
          ]
        },
        {
          "displayName": "Range",
          "name": "range",
          "type": "fixedCollection",
          "placeholder": "Add Range",
          "description": "Range of time to retrieve the exchange rate for",
          "default": {},
          "options": [
            {
              "displayName": "Range Properties",
              "name": "rangeProperties",
              "values": [
                {
                  "displayName": "Range Start",
                  "name": "from",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "Range End",
                  "name": "to",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Time",
          "name": "time",
          "type": "dateTime",
          "default": "",
          "description": "Point in time to retrieve the exchange rate for"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "exchangeRate"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a profile"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many profiles"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile to retrieve. 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": [
            "profile"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a quote"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a quote"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile to create the quote under. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "displayName": "Target Account Name or ID",
      "name": "targetAccountId",
      "type": "options",
      "default": [],
      "description": "ID of the account that will receive the funds. 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": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getRecipients"
      }
    },
    {
      "displayName": "Amount Type",
      "name": "amountType",
      "type": "options",
      "default": "source",
      "description": "Whether the amount is to be sent or received",
      "options": [
        {
          "name": "Source",
          "value": "source"
        },
        {
          "name": "Target",
          "value": "target"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 1,
      "description": "Amount of funds for the quote to create",
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Source Currency",
      "name": "sourceCurrency",
      "type": "string",
      "default": "",
      "description": "Code of the currency to send for the quote to create",
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Target Currency",
      "name": "targetCurrency",
      "type": "string",
      "default": "",
      "description": "Code of the currency to receive for the quote to create",
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "description": "ID of the quote to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many recipients"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "recipient"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "recipient"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "recipient"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a transfer"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a transfer"
        },
        {
          "name": "Execute",
          "value": "execute",
          "action": "Execute a transfer"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a transfer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many transfers"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile to retrieve the balance of. 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": [
            "transfer"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles",
        "loadOptionsDependsOn": [
          "profileId"
        ]
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "description": "ID of the quote based on which to create the transfer",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Target Account Name or ID",
      "name": "targetAccountId",
      "type": "options",
      "default": [],
      "description": "ID of the account that will receive the funds. 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": [
            "transfer"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getRecipients"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Reference",
          "name": "reference",
          "type": "string",
          "default": "",
          "description": "Reference text to show in the recipient's bank statement"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Transfer ID",
      "name": "transferId",
      "type": "string",
      "default": "",
      "description": "ID of the transfer to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile to execute the transfer under. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "execute"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "displayName": "Transfer ID",
      "name": "transferId",
      "type": "string",
      "default": "",
      "description": "ID of the transfer to execute",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "execute"
          ]
        }
      }
    },
    {
      "displayName": "Transfer ID",
      "name": "transferId",
      "type": "string",
      "default": "",
      "description": "ID of the transfer to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Download Receipt",
      "name": "downloadReceipt",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the transfer receipt as a PDF file. Only for executed transfers, having status 'Outgoing Payment Sent'.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryProperty",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "get"
          ],
          "downloadReceipt": [
            true
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the file that will be downloaded",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "get"
          ],
          "downloadReceipt": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": [],
      "description": "ID of the user profile to retrieve. 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": [
            "transfer"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "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": [
            "transfer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Range",
          "name": "range",
          "type": "fixedCollection",
          "placeholder": "Add Range",
          "description": "Range of time for filtering the transfers",
          "default": {},
          "options": [
            {
              "displayName": "Range Properties",
              "name": "rangeProperties",
              "values": [
                {
                  "displayName": "Created Date Start",
                  "name": "createdDateStart",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "Created Date End",
                  "name": "createdDateEnd",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Source Currency",
          "name": "sourceCurrency",
          "type": "string",
          "default": "",
          "description": "Code of the source currency for filtering the transfers"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "processing",
          "options": [
            {
              "name": "Bounced Back",
              "value": "bounced_back"
            },
            {
              "name": "Cancelled",
              "value": "cancelled"
            },
            {
              "name": "Charged Back",
              "value": "charged_back"
            },
            {
              "name": "Funds Converted",
              "value": "funds_converted"
            },
            {
              "name": "Funds Refunded",
              "value": "funds_refunded"
            },
            {
              "name": "Incoming Payment Waiting",
              "value": "incoming_payment_waiting"
            },
            {
              "name": "Outgoing Payment Sent",
              "value": "outgoing_payment_sent"
            },
            {
              "name": "Processing",
              "value": "processing"
            },
            {
              "name": "Unknown",
              "value": "unknown"
            },
            {
              "name": "Waiting for Recipient Input to Proceed",
              "value": "waiting_recipient_input_to_proceed"
            }
          ]
        },
        {
          "displayName": "Target Currency",
          "name": "targetCurrency",
          "type": "string",
          "default": "",
          "description": "Code of the target currency for filtering the transfers"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transfer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getBalances",
      "name": "Get Balances",
      "description": "Retrieve balances for all account currencies of this user"
    },
    {
      "operation": "getCurrencies",
      "name": "Get Currencies",
      "description": "Retrieve currencies in the borderless account of this user"
    },
    {
      "operation": "getStatement",
      "name": "Get Statement",
      "description": "Retrieve the statement for the borderless account of this user"
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Wise Trigger node documentation
  description: Learn how to use the Wise Trigger node in n8n. Follow technical documentation to integrate Wise Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Wise Trigger node

  [Wise](https://wise.com) allows you to transfer money abroad with low-cost money transfers, receive money with international account details, and track transactions on your phone.

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

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

  ## Events

  - Triggered every time a balance account is credited
  - Triggered every time a balance account is credited or debited
  - Triggered every time a transfer's list of active cases is updated
  - Triggered every time a transfer's status is updated 

properties_schema:
  [
    {
      "displayName": "Profile Name or ID",
      "name": "profileId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getProfiles"
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Balance Credit",
          "value": "balanceCredit",
          "description": "Triggered every time a balance account is credited"
        },
        {
          "name": "Balance Update",
          "value": "balanceUpdate",
          "description": "Triggered every time a balance account is credited or debited"
        },
        {
          "name": "Transfer Active Case",
          "value": "transferActiveCases",
          "description": "Triggered every time a transfer's list of active cases is updated"
        },
        {
          "name": "Transfer State Changed",
          "value": "tranferStateChange",
          "description": "Triggered every time a transfer's status is updated"
        }
      ],
      "required": true
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # WooCommerce node

  Use the WooCommerce node to automate work in WooCommerce, and integrate WooCommerce with other applications. n8n has built-in support for a wide range of WooCommerce features, including creating and deleting customers, orders, and products. 

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

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

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

  ## Operations

  * Customer
      * Create a customer
      * Delete a customer
      * Retrieve a customer
      * Retrieve all customers
      * Update a customer
  * Order
      * Create a order
      * Delete a order
      * Get a order
      * Get all orders
      * Update an order
  * Product
      * Create a product
      * Delete a product
      * Get a product
      * Get all products
      * Update a product

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "product",
      "options": [
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Order",
          "value": "order"
        },
        {
          "name": "Product",
          "value": "product"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a customer",
          "action": "Create a customer"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a customer",
          "action": "Delete a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a customer",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many customers",
          "action": "Get many customers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a customer",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billing Address",
          "name": "billing",
          "type": "collection",
          "default": {},
          "placeholder": "Add Field",
          "options": [
            {
              "displayName": "First Name",
              "name": "first_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "last_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postcode",
              "name": "postcode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Metadata",
          "name": "meta_data",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Metadata Field",
          "options": [
            {
              "displayName": "Metadata Fields",
              "name": "meta_data_fields",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "displayOptions": {
            "show": {
              "/resource": [
                "customer"
              ],
              "/operation": [
                "create"
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Shipping Address",
          "name": "shipping",
          "type": "collection",
          "default": {},
          "placeholder": "Add Field",
          "options": [
            {
              "displayName": "First Name",
              "name": "first_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "last_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postcode",
              "name": "postcode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        },
        {
          "displayName": "Username",
          "name": "username",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "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": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email address to filter customers by"
        },
        {
          "displayName": "Sort Order",
          "name": "order",
          "description": "Order to sort customers in",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "asc"
            },
            {
              "name": "Descending",
              "value": "desc"
            }
          ],
          "default": "asc"
        },
        {
          "displayName": "Order By",
          "name": "orderby",
          "description": "Field to sort customers by",
          "type": "options",
          "options": [
            {
              "name": "ID",
              "value": "id"
            },
            {
              "name": "Include",
              "value": "include"
            },
            {
              "name": "Name",
              "value": "name"
            },
            {
              "name": "Registered Date",
              "value": "registered_date"
            }
          ],
          "default": "id"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billing Address",
          "name": "billing",
          "type": "collection",
          "default": {},
          "placeholder": "Add Field",
          "options": [
            {
              "displayName": "First Name",
              "name": "first_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "last_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postcode",
              "name": "postcode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Metadata",
          "name": "meta_data",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Metadata Field",
          "options": [
            {
              "displayName": "Metadata Fields",
              "name": "meta_data_fields",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "displayOptions": {
            "show": {
              "/resource": [
                "customer"
              ],
              "/operation": [
                "create"
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Shipping Address",
          "name": "shipping",
          "type": "collection",
          "default": {},
          "placeholder": "Add Field",
          "options": [
            {
              "displayName": "First Name",
              "name": "first_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "last_name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postcode",
              "name": "postcode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a product",
          "action": "Create a product"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a product",
          "action": "Delete a product"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a product",
          "action": "Get a product"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many products",
          "action": "Get many products"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a product",
          "action": "Update a product"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Product name",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Backorders",
          "name": "backorders",
          "type": "options",
          "options": [
            {
              "name": "No",
              "value": "no"
            },
            {
              "name": "Notify",
              "value": "notify"
            },
            {
              "name": "Yes",
              "value": "yes"
            }
          ],
          "default": "no",
          "description": "If managing stock, this controls if backorders are allowed"
        },
        {
          "displayName": "Button Text",
          "name": "buttonText",
          "type": "string",
          "default": "",
          "description": "Product external button text. Only for external products."
        },
        {
          "displayName": "Catalog Visibility",
          "name": "catalogVisibility",
          "type": "options",
          "options": [
            {
              "name": "Catalog",
              "value": "catalog"
            },
            {
              "name": "Hidden",
              "value": "hidden"
            },
            {
              "name": "Search",
              "value": "search"
            },
            {
              "name": "Visible",
              "value": "visible"
            }
          ],
          "default": "visible"
        },
        {
          "displayName": "Category Names or IDs",
          "name": "categories",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "default": [],
          "description": "List of categories. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Cross Sell IDs",
          "name": "crossSellIds",
          "type": "string",
          "default": "",
          "description": "List of cross-sell products IDs. Multiple can be added separated by ,."
        },
        {
          "displayName": "Date On Sale From",
          "name": "dateOnSaleFrom",
          "type": "dateTime",
          "default": "",
          "description": "Start date of sale price, in the site's timezone"
        },
        {
          "displayName": "Date On Sale To",
          "name": "dateOnSaleTo",
          "type": "dateTime",
          "default": "",
          "description": "Ennd date of sale price, in the site's timezone"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Product description"
        },
        {
          "displayName": "Downloadable",
          "name": "downloadable",
          "type": "boolean",
          "default": false,
          "description": "Whether the product is downloadable"
        },
        {
          "displayName": "External URL",
          "name": "externalUrl",
          "type": "string",
          "default": "",
          "description": "Product external URL. Only for external products."
        },
        {
          "displayName": "Featured",
          "name": "featured",
          "type": "boolean",
          "default": false,
          "description": "Whether the product is featured"
        },
        {
          "displayName": "Manage Stock",
          "name": "manageStock",
          "type": "boolean",
          "default": false,
          "description": "Stock management at product level"
        },
        {
          "displayName": "Menu Order",
          "name": "menuOrder",
          "type": "number",
          "default": 1,
          "description": "Menu order, used to custom sort products"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "Product parent ID"
        },
        {
          "displayName": "Purchase Note",
          "name": "purchaseNote",
          "type": "string",
          "default": "",
          "description": "Optional note to send the customer after purchase"
        },
        {
          "displayName": "Regular Price",
          "name": "regularPrice",
          "type": "string",
          "default": "",
          "description": "Product regular price"
        },
        {
          "displayName": "Reviews Allowed",
          "name": "reviewsAllowed",
          "type": "boolean",
          "default": true,
          "description": "Whether to allow reviews"
        },
        {
          "displayName": "Sale Price",
          "name": "salePrice",
          "type": "string",
          "default": "",
          "description": "Product sale price"
        },
        {
          "displayName": "Shipping Class",
          "name": "shippingClass",
          "type": "string",
          "default": "",
          "description": "Shipping class slug"
        },
        {
          "displayName": "Short Description",
          "name": "shortDescription",
          "type": "string",
          "default": "",
          "description": "Product short description"
        },
        {
          "displayName": "SKU",
          "name": "sku",
          "type": "string",
          "default": "",
          "description": "Unique identifier"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "Product slug"
        },
        {
          "displayName": "Sold Individually",
          "name": "soldIndividually",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow one item to be bought in a single order"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "publish",
          "description": "A named status for the product"
        },
        {
          "displayName": "Stock Quantity",
          "name": "stockQuantity",
          "type": "number",
          "default": 1
        },
        {
          "displayName": "Stock Status",
          "name": "stockStatus",
          "type": "options",
          "options": [
            {
              "name": "In Stock",
              "value": "instock"
            },
            {
              "name": "Out Of Stock",
              "value": "outofstock"
            },
            {
              "name": "On Back Order",
              "value": "onbackorder"
            }
          ],
          "default": "instock",
          "description": "Controls the stock status of the product"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "List of tags. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tax Class",
          "name": "taxClass",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Status",
          "name": "taxStatus",
          "type": "options",
          "options": [
            {
              "name": "Taxable",
              "value": "taxable"
            },
            {
              "name": "Shipping",
              "value": "shipping"
            },
            {
              "name": "None",
              "value": "none"
            }
          ],
          "default": "taxable"
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "options": [
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grouped",
              "value": "grouped"
            },
            {
              "name": "External",
              "value": "external"
            },
            {
              "name": "Variable",
              "value": "variable"
            }
          ],
          "default": "simple",
          "description": "Product type"
        },
        {
          "displayName": "Upsell IDs",
          "name": "upsellIds",
          "type": "string",
          "default": "",
          "description": "List of up-sell products IDs. Multiple can be added separated by ,."
        },
        {
          "displayName": "Virtual",
          "name": "virtual",
          "type": "boolean",
          "default": false,
          "description": "Whether the product is virtual"
        },
        {
          "displayName": "Weight",
          "name": "weight",
          "type": "string",
          "default": "",
          "description": "Product weight"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Dimensions",
      "name": "dimensionsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Product dimensions",
      "options": [
        {
          "name": "dimensionsValues",
          "displayName": "Dimension",
          "values": [
            {
              "displayName": "Height",
              "name": "height",
              "type": "string",
              "default": "",
              "description": "Product height"
            },
            {
              "displayName": "Length",
              "name": "length",
              "type": "string",
              "default": "",
              "description": "Product length"
            },
            {
              "displayName": "Width",
              "name": "width",
              "type": "string",
              "default": "",
              "description": "Product width"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Images",
      "name": "imagesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Product Image",
      "options": [
        {
          "name": "imagesValues",
          "displayName": "Image",
          "values": [
            {
              "displayName": "Alt",
              "name": "alt",
              "type": "string",
              "default": "",
              "description": "Image alternative text"
            },
            {
              "displayName": "Src",
              "name": "src",
              "type": "string",
              "default": "",
              "description": "Image URL"
            },
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Image name"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Meta data",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Name of the metadata key to add"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Product ID",
      "name": "productId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Backorders",
          "name": "backorders",
          "type": "options",
          "options": [
            {
              "name": "No",
              "value": "no"
            },
            {
              "name": "Notify",
              "value": "notify"
            },
            {
              "name": "Yes",
              "value": "yes"
            }
          ],
          "default": "no",
          "description": "If managing stock, this controls if backorders are allowed"
        },
        {
          "displayName": "Button Text",
          "name": "buttonText",
          "type": "string",
          "default": "",
          "description": "Product external button text. Only for external products."
        },
        {
          "displayName": "Catalog Visibility",
          "name": "catalogVisibility",
          "type": "options",
          "options": [
            {
              "name": "Visible",
              "value": "visible"
            },
            {
              "name": "Catalog",
              "value": "catalog"
            },
            {
              "name": "Search",
              "value": "search"
            },
            {
              "name": "Hidden",
              "value": "hidden"
            }
          ],
          "default": "visible"
        },
        {
          "displayName": "Category Names or IDs",
          "name": "categories",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "default": [],
          "description": "List of categories. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Cross Sell IDs",
          "name": "crossSellIds",
          "type": "string",
          "default": "",
          "description": "List of cross-sell products IDs. Multiple can be added separated by ,."
        },
        {
          "displayName": "Date On Sale From",
          "name": "dateOnSaleFrom",
          "type": "dateTime",
          "default": "",
          "description": "Start date of sale price, in the site's timezone"
        },
        {
          "displayName": "Date On Sale To",
          "name": "dateOnSaleTo",
          "type": "dateTime",
          "default": "",
          "description": "Ennd date of sale price, in the site's timezone"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Product description"
        },
        {
          "displayName": "Downloadable",
          "name": "downloadable",
          "type": "boolean",
          "default": false,
          "description": "Whether the product is downloadable"
        },
        {
          "displayName": "External URL",
          "name": "externalUrl",
          "type": "string",
          "default": "",
          "description": "Product external URL. Only for external products."
        },
        {
          "displayName": "Featured",
          "name": "featured",
          "type": "boolean",
          "default": false,
          "description": "Whether the product is featured"
        },
        {
          "displayName": "Manage Stock",
          "name": "manageStock",
          "type": "boolean",
          "default": false,
          "description": "Stock management at product level"
        },
        {
          "displayName": "Menu Order",
          "name": "menuOrder",
          "type": "number",
          "default": 1,
          "description": "Menu order, used to custom sort products"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Product name"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "Product parent ID"
        },
        {
          "displayName": "Purchase Note",
          "name": "purchaseNote",
          "type": "string",
          "default": "",
          "description": "Optional note to send the customer after purchase"
        },
        {
          "displayName": "Regular Price",
          "name": "regularPrice",
          "type": "string",
          "default": "",
          "description": "Product regular price"
        },
        {
          "displayName": "Reviews Allowed",
          "name": "reviewsAllowed",
          "type": "boolean",
          "default": true,
          "description": "Whether to allow reviews"
        },
        {
          "displayName": "Sale Price",
          "name": "salePrice",
          "type": "string",
          "default": "",
          "description": "Product sale price"
        },
        {
          "displayName": "Shipping Class",
          "name": "shippingClass",
          "type": "string",
          "default": "",
          "description": "Shipping class slug"
        },
        {
          "displayName": "Short Description",
          "name": "shortDescription",
          "type": "string",
          "default": "",
          "description": "Product short description"
        },
        {
          "displayName": "SKU",
          "name": "sku",
          "type": "string",
          "default": "",
          "description": "Unique identifier"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "Product slug"
        },
        {
          "displayName": "Sold Individually",
          "name": "soldIndividually",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow one item to be bought in a single order"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "publish",
          "description": "A named status for the product"
        },
        {
          "displayName": "Stock Quantity",
          "name": "stockQuantity",
          "type": "number",
          "default": 1
        },
        {
          "displayName": "Stock Status",
          "name": "stockStatus",
          "type": "options",
          "options": [
            {
              "name": "In Stock",
              "value": "instock"
            },
            {
              "name": "Out Of Stock",
              "value": "outofstock"
            },
            {
              "name": "On Back Order",
              "value": "onbackorder"
            }
          ],
          "default": "instock",
          "description": "Controls the stock status of the product"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "List of tags. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tax Class",
          "name": "taxClass",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Status",
          "name": "taxStatus",
          "type": "options",
          "options": [
            {
              "name": "Taxable",
              "value": "taxable"
            },
            {
              "name": "Shipping",
              "value": "shipping"
            },
            {
              "name": "None",
              "value": "none"
            }
          ],
          "default": "taxable"
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "options": [
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grouped",
              "value": "grouped"
            },
            {
              "name": "External",
              "value": "external"
            },
            {
              "name": "Variable",
              "value": "variable"
            }
          ],
          "default": "simple",
          "description": "Product type"
        },
        {
          "displayName": "Upsell IDs",
          "name": "upsellIds",
          "type": "string",
          "default": "",
          "description": "List of up-sell products IDs. Multiple can be added separated by ,."
        },
        {
          "displayName": "Virtual",
          "name": "virtual",
          "type": "boolean",
          "default": false,
          "description": "Whether the product is virtual"
        },
        {
          "displayName": "Weight",
          "name": "weight",
          "type": "string",
          "default": "",
          "description": "Product weight"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Dimensions",
      "name": "dimensionsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Product dimensions",
      "options": [
        {
          "name": "dimensionsValues",
          "displayName": "Dimension",
          "values": [
            {
              "displayName": "Height",
              "name": "height",
              "type": "string",
              "default": "",
              "description": "Product height"
            },
            {
              "displayName": "Length",
              "name": "length",
              "type": "string",
              "default": "",
              "description": "Product length"
            },
            {
              "displayName": "Width",
              "name": "width",
              "type": "string",
              "default": "",
              "description": "Product width"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Images",
      "name": "imagesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Product Image",
      "options": [
        {
          "name": "imagesValues",
          "displayName": "Image",
          "values": [
            {
              "displayName": "Alt",
              "name": "alt",
              "type": "string",
              "default": "",
              "description": "Image alternative text"
            },
            {
              "displayName": "Src",
              "name": "src",
              "type": "string",
              "default": "",
              "description": "Image URL"
            },
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Image name"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Meta data",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Name of the metadata key to add"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Product ID",
      "name": "productId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "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": [
            "product"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "After",
          "name": "after",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to resources published after a given ISO8601 compliant date"
        },
        {
          "displayName": "Before",
          "name": "before",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to resources published before a given ISO8601 compliant date"
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "type": "options",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "description": "Limit result set to products assigned a specific category ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        },
        {
          "displayName": "Featured",
          "name": "featured",
          "type": "boolean",
          "default": false,
          "description": "Whether to limit the result set to featured products"
        },
        {
          "displayName": "Max Price",
          "name": "maxPrice",
          "type": "string",
          "default": "",
          "description": "Limit result set to products based on a maximun price"
        },
        {
          "displayName": "Min Price",
          "name": "minPrice",
          "type": "string",
          "default": "",
          "description": "Limit result set to products based on a minimum price"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Order sort attribute ascending or descending"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "options",
          "options": [
            {
              "name": "Date",
              "value": "date"
            },
            {
              "name": "ID",
              "value": "id"
            },
            {
              "name": "Include",
              "value": "include"
            },
            {
              "name": "Slug",
              "value": "slug"
            },
            {
              "name": "Title",
              "value": "title"
            }
          ],
          "default": "id",
          "description": "Sort collection by object attribute"
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Limit results to those matching a string"
        },
        {
          "displayName": "SKU",
          "name": "sku",
          "type": "string",
          "default": "",
          "description": "Limit result set to products with a specific SKU"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "Limit result set to products with a specific slug"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Any",
              "value": "any"
            },
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "any",
          "description": "Limit result set to products assigned a specific status"
        },
        {
          "displayName": "Stock Status",
          "name": "stockStatus",
          "type": "options",
          "options": [
            {
              "name": "In Stock",
              "value": "instock"
            },
            {
              "name": "Out Of Stock",
              "value": "outofstock"
            },
            {
              "name": "On Back Order",
              "value": "onbackorder"
            }
          ],
          "default": "",
          "description": "Controls the stock status of the product"
        },
        {
          "displayName": "Tag Name or ID",
          "name": "tag",
          "type": "options",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "description": "Limit result set to products assigned a specific tag ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tax Class",
          "name": "taxClass",
          "type": "options",
          "options": [
            {
              "name": "Standar",
              "value": "standard"
            },
            {
              "name": "Reduced Rate",
              "value": "reduced-rate"
            },
            {
              "name": "Zero Rate",
              "value": "zero-rate."
            }
          ],
          "default": "",
          "description": "Limit result set to products with a specific tax class"
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "options": [
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grouped",
              "value": "grouped"
            },
            {
              "name": "External",
              "value": "external"
            },
            {
              "name": "Variable",
              "value": "variable"
            }
          ],
          "default": "simple",
          "description": "Product type"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Product ID",
      "name": "productId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a order",
          "action": "Create an order"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a order",
          "action": "Delete an order"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a order",
          "action": "Get an order"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many orders",
          "action": "Get many orders"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a order",
          "action": "Update an order"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": "",
          "description": "Currency the order was created with"
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "string",
          "default": "",
          "description": "User ID who owns the order. 0 for guests."
        },
        {
          "displayName": "Customer Note",
          "name": "customerNote",
          "type": "string",
          "default": "",
          "description": "Note left by customer during checkout"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "Parent order ID"
        },
        {
          "displayName": "Payment Method ID",
          "name": "paymentMethodId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Payment Method Title",
          "name": "paymentMethodTitle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Set Paid",
          "name": "setPaid",
          "type": "boolean",
          "default": false,
          "description": "Whether the order is paid. It will set the status to processing and reduce stock items."
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Cancelled",
              "value": "cancelled"
            },
            {
              "name": "Completed",
              "value": "completed"
            },
            {
              "name": "Failed",
              "value": "failed"
            },
            {
              "name": "on-hold",
              "value": "on-hold"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Processing",
              "value": "processing"
            },
            {
              "name": "Refunded",
              "value": "refunded"
            },
            {
              "name": "Trash",
              "value": "trash"
            }
          ],
          "default": "pending",
          "description": "A named status for the order"
        },
        {
          "displayName": "Transaction ID",
          "name": "transactionID",
          "type": "string",
          "default": "",
          "description": "Unique transaction ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Billing",
      "name": "billingUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Billing address",
      "options": [
        {
          "name": "billingValues",
          "displayName": "Address",
          "values": [
            {
              "displayName": "First Name",
              "name": "firstName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "lastName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": "",
              "description": "ISO code or name of the state, province or district"
            },
            {
              "displayName": "Postal Code",
              "name": "postcode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Coupon Lines",
      "name": "couponLinesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Coupons line data",
      "options": [
        {
          "name": "couponLinesValues",
          "displayName": "Coupon Line",
          "values": [
            {
              "displayName": "Code",
              "name": "code",
              "type": "string",
              "default": "",
              "description": "Coupon code"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Fee Lines",
      "name": "feeLinesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Fee line data",
      "options": [
        {
          "name": "feeLinesValues",
          "displayName": "Fee Line",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Fee name"
            },
            {
              "displayName": "Tax Class",
              "name": "taxClass",
              "type": "string",
              "description": "Tax class of fee",
              "default": ""
            },
            {
              "displayName": "Tax Status",
              "name": "taxStatus",
              "type": "options",
              "options": [
                {
                  "name": "Taxable",
                  "value": "taxable"
                },
                {
                  "name": "None",
                  "value": "none"
                }
              ],
              "default": "",
              "description": "Tax class of fee"
            },
            {
              "displayName": "Total",
              "name": "total",
              "type": "string",
              "default": "",
              "description": "Line total (after discounts)"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Line Items",
      "name": "lineItemsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Line item data",
      "options": [
        {
          "name": "lineItemsValues",
          "displayName": "Line Item",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Product name"
            },
            {
              "displayName": "Product ID",
              "name": "productId",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Variation ID",
              "name": "variationId",
              "type": "number",
              "default": 0,
              "description": "Variation ID, if applicable"
            },
            {
              "displayName": "Quantity",
              "name": "quantity",
              "type": "number",
              "default": 1,
              "description": "Quantity ordered"
            },
            {
              "displayName": "Tax Class",
              "name": "taxClass",
              "type": "string",
              "default": "",
              "description": "Slug of the tax class of product"
            },
            {
              "displayName": "Subtotal",
              "name": "subtotal",
              "type": "string",
              "default": "",
              "description": "Line subtotal (before discounts)"
            },
            {
              "displayName": "Total",
              "name": "total",
              "type": "string",
              "default": "",
              "description": "Line total (after discounts)"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Meta data",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Name of the metadata key to add"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Shipping",
      "name": "shippingUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Shipping address",
      "options": [
        {
          "name": "shippingValues",
          "displayName": "Address",
          "values": [
            {
              "displayName": "First Name",
              "name": "firstName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "lastName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": "",
              "description": "ISO code or name of the state, province or district"
            },
            {
              "displayName": "Postal Code",
              "name": "postcode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Shipping Lines",
      "name": "shippingLinesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Shipping line data",
      "options": [
        {
          "name": "shippingLinesValues",
          "displayName": "Fee Line",
          "values": [
            {
              "displayName": "Method Title",
              "name": "methodTitle",
              "type": "string",
              "default": "",
              "description": "Shipping method name"
            },
            {
              "displayName": "Method ID",
              "name": "method ID",
              "type": "string",
              "description": "Shipping method ID",
              "default": ""
            },
            {
              "displayName": "Total",
              "name": "total",
              "type": "string",
              "default": "",
              "description": "Line total (after discounts)"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Order ID",
      "name": "orderId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": "",
          "description": "Currency the order was created with"
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "string",
          "default": "",
          "description": "User ID who owns the order. 0 for guests."
        },
        {
          "displayName": "Customer Note",
          "name": "customerNote",
          "type": "string",
          "default": "",
          "description": "Note left by customer during checkout"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "Parent order ID"
        },
        {
          "displayName": "Payment Method ID",
          "name": "paymentMethodId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Payment Method Title",
          "name": "paymentMethodTitle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Cancelled",
              "value": "cancelled"
            },
            {
              "name": "Completed",
              "value": "completed"
            },
            {
              "name": "Failed",
              "value": "failed"
            },
            {
              "name": "on-hold",
              "value": "on-hold"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Processing",
              "value": "processing"
            },
            {
              "name": "Refunded",
              "value": "refunded"
            },
            {
              "name": "Trash",
              "value": "trash"
            }
          ],
          "default": "pending",
          "description": "A named status for the order"
        },
        {
          "displayName": "Transaction ID",
          "name": "transactionID",
          "type": "string",
          "default": "",
          "description": "Unique transaction ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Billing",
      "name": "billingUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Billing address",
      "options": [
        {
          "name": "billingValues",
          "displayName": "Address",
          "values": [
            {
              "displayName": "First Name",
              "name": "firstName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "lastName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": "",
              "description": "ISO code or name of the state, province or district"
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Coupon Lines",
      "name": "couponLinesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Coupons line data",
      "options": [
        {
          "name": "couponLinesValues",
          "displayName": "Coupon Line",
          "values": [
            {
              "displayName": "Code",
              "name": "code",
              "type": "string",
              "default": "",
              "description": "Coupon code"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Fee Lines",
      "name": "feeLinesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Fee line data",
      "options": [
        {
          "name": "feeLinesValues",
          "displayName": "Fee Line",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Fee name"
            },
            {
              "displayName": "Tax Class",
              "name": "taxClass",
              "type": "string",
              "description": "Tax class of fee",
              "default": ""
            },
            {
              "displayName": "Tax Status",
              "name": "taxStatus",
              "type": "options",
              "options": [
                {
                  "name": "Taxable",
                  "value": "taxable"
                },
                {
                  "name": "None",
                  "value": "none"
                }
              ],
              "default": "",
              "description": "Tax class of fee"
            },
            {
              "displayName": "Total",
              "name": "total",
              "type": "string",
              "default": "",
              "description": "Line total (after discounts)"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Line Items",
      "name": "lineItemsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Line item data",
      "options": [
        {
          "name": "lineItemsValues",
          "displayName": "Line Item",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Product name"
            },
            {
              "displayName": "Product ID",
              "name": "productId",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Variation ID",
              "name": "variationId",
              "type": "number",
              "default": 0,
              "description": "Variation ID, if applicable"
            },
            {
              "displayName": "Quantity",
              "name": "quantity",
              "type": "number",
              "default": 1,
              "description": "Quantity ordered"
            },
            {
              "displayName": "Tax Class",
              "name": "taxClass",
              "type": "string",
              "default": "",
              "description": "Slug of the tax class of product"
            },
            {
              "displayName": "Subtotal",
              "name": "subtotal",
              "type": "string",
              "default": "",
              "description": "Line subtotal (before discounts)"
            },
            {
              "displayName": "Total",
              "name": "total",
              "type": "string",
              "default": "",
              "description": "Line total (after discounts)"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Meta data",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Name of the metadata key to add"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Shipping",
      "name": "shippingUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Shipping address",
      "options": [
        {
          "name": "shippingValues",
          "displayName": "Address",
          "values": [
            {
              "displayName": "First Name",
              "name": "firstName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "lastName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Company",
              "name": "company",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 1",
              "name": "address_1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Address Line 2",
              "name": "address_2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": "",
              "description": "ISO code or name of the state, province or district"
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Shipping Lines",
      "name": "shippingLinesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Shipping line data",
      "options": [
        {
          "name": "shippingLinesValues",
          "displayName": "Fee Line",
          "values": [
            {
              "displayName": "Method Title",
              "name": "methodTitle",
              "type": "string",
              "default": "",
              "description": "Shipping method name"
            },
            {
              "displayName": "Method ID",
              "name": "method ID",
              "type": "string",
              "description": "Shipping method ID",
              "default": ""
            },
            {
              "displayName": "Total",
              "name": "total",
              "type": "string",
              "default": "",
              "description": "Line total (after discounts)"
            },
            {
              "displayName": "Metadata",
              "name": "metadataUi",
              "placeholder": "Add Metadata",
              "type": "fixedCollection",
              "default": {},
              "typeOptions": {
                "multipleValues": true
              },
              "description": "Meta data",
              "options": [
                {
                  "name": "metadataValues",
                  "displayName": "Metadata",
                  "values": [
                    {
                      "displayName": "Key",
                      "name": "key",
                      "type": "string",
                      "default": "",
                      "description": "Name of the metadata key to add"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": "",
                      "description": "Value to set for the metadata key"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Order ID",
      "name": "orderId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "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": [
            "order"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "After",
          "name": "after",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to resources published after a given ISO8601 compliant date"
        },
        {
          "displayName": "Before",
          "name": "before",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to resources published before a given ISO8601 compliant date"
        },
        {
          "displayName": "Customer",
          "name": "customer",
          "type": "string",
          "default": "",
          "description": "Limit result set to orders assigned a specific customer"
        },
        {
          "displayName": "Decimal Points",
          "name": "decimalPoints",
          "type": "number",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 10
          },
          "default": 2,
          "description": "Number of decimal points to use in each resource"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Order sort attribute ascending or descending"
        },
        {
          "displayName": "Product",
          "name": "product",
          "type": "string",
          "default": "",
          "description": "Limit result set to orders assigned a specific product"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "options",
          "options": [
            {
              "name": "Date",
              "value": "date"
            },
            {
              "name": "ID",
              "value": "id"
            },
            {
              "name": "Include",
              "value": "include"
            },
            {
              "name": "Slug",
              "value": "slug"
            },
            {
              "name": "Title",
              "value": "title"
            }
          ],
          "default": "id",
          "description": "Sort collection by object attribute"
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Limit results to those matching a string"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Any",
              "value": "any"
            },
            {
              "name": "Cancelled",
              "value": "cancelled"
            },
            {
              "name": "Completed",
              "value": "completed"
            },
            {
              "name": "Failed",
              "value": "failed"
            },
            {
              "name": "On-Hold",
              "value": "on-hold"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Processing",
              "value": "processing"
            },
            {
              "name": "Refunded",
              "value": "refunded"
            },
            {
              "name": "Trash",
              "value": "trash"
            }
          ],
          "default": "any",
          "description": "Limit result set to orders assigned a specific status"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Order ID",
      "name": "orderId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "order"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

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

  # WooCommerce Trigger node

  [WooCommerce](https://woocommerce.com/){:target=_blank .external-link} is a customizable, open-source e-commerce plugin for WordPress.

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

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

  ## Events

  - coupon.created
  - coupon.updated
  - coupon.deleted
  - customer.created
  - customer.updated
  - customer.deleted
  - order.created
  - order.updated
  - order.deleted
  - product.created
  - product.updated
  - product.deleted

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "description": "Determines which resource events the webhook is triggered for",
      "options": [
        {
          "name": "coupon.created",
          "value": "coupon.created"
        },
        {
          "name": "coupon.deleted",
          "value": "coupon.deleted"
        },
        {
          "name": "coupon.updated",
          "value": "coupon.updated"
        },
        {
          "name": "customer.created",
          "value": "customer.created"
        },
        {
          "name": "customer.deleted",
          "value": "customer.deleted"
        },
        {
          "name": "customer.updated",
          "value": "customer.updated"
        },
        {
          "name": "order.created",
          "value": "order.created"
        },
        {
          "name": "order.deleted",
          "value": "order.deleted"
        },
        {
          "name": "order.updated",
          "value": "order.updated"
        },
        {
          "name": "product.created",
          "value": "product.created"
        },
        {
          "name": "product.deleted",
          "value": "product.deleted"
        },
        {
          "name": "product.updated",
          "value": "product.updated"
        }
      ],
      "required": true
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # WordPress node

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

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

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

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

  ## Operations

  * Post
      * Create a post
      * Get a post
      * Get all posts
      * Update a post
  * Pages
      * Create a page
      * Get a page
      * Get all pages
      * Update a page
  * User
      * Create a user
      * Get a user
      * Get all users
      * Update a user

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Post",
          "value": "post"
        },
        {
          "name": "Page",
          "value": "page"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a post",
          "action": "Create a post"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a post",
          "action": "Get a post"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many posts",
          "action": "Get many posts"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a post",
          "action": "Update a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "The title for the post",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Author Name or ID",
          "name": "authorId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAuthors"
          },
          "default": "",
          "description": "The ID for the author of the object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Content",
          "name": "content",
          "type": "string",
          "default": "",
          "description": "The content for the post"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "An alphanumeric identifier for the object unique to its type"
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "A password to protect access to the content and excerpt"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Future",
              "value": "future"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "draft",
          "description": "A named status for the post"
        },
        {
          "displayName": "Date",
          "name": "date",
          "type": "dateTime",
          "default": "",
          "description": "The date the post was published, in the site's timezone"
        },
        {
          "displayName": "Comment Status",
          "name": "commentStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the post"
        },
        {
          "displayName": "Ping Status",
          "name": "pingStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "If the a message should be send to announce the post"
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "options": [
            {
              "name": "Aside",
              "value": "aside"
            },
            {
              "name": "Audio",
              "value": "audio"
            },
            {
              "name": "Chat",
              "value": "chat"
            },
            {
              "name": "Gallery",
              "value": "gallery"
            },
            {
              "name": "Image",
              "value": "image"
            },
            {
              "name": "Link",
              "value": "link"
            },
            {
              "name": "Quote",
              "value": "quote"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Video",
              "value": "video"
            }
          ],
          "default": "standard",
          "description": "Whether or not comments are open on the post"
        },
        {
          "displayName": "Sticky",
          "name": "sticky",
          "type": "boolean",
          "default": false,
          "description": "Whether or not the object should be treated as sticky"
        },
        {
          "displayName": "Category Names or IDs",
          "name": "categories",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "default": [],
          "description": "The terms assigned to the object in the category taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The terms assigned to the object in the post_tag taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Template",
          "name": "postTemplate",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Elementor Template",
                  "name": "elementor",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether site uses elementor page builder"
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "string",
                  "default": "",
                  "description": "The theme file to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        false
                      ]
                    }
                  }
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "options",
                  "options": [
                    {
                      "name": "Standard",
                      "value": ""
                    },
                    {
                      "name": "Elementor Canvas",
                      "value": "elementor_canvas"
                    },
                    {
                      "name": "Elementor Header Footer",
                      "value": "elementor_header_footer"
                    },
                    {
                      "name": "Elementor Theme",
                      "value": "elementor_theme"
                    }
                  ],
                  "default": "",
                  "description": "The Elementor template to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        true
                      ]
                    }
                  }
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the object",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Author Name or ID",
          "name": "authorId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAuthors"
          },
          "default": "",
          "description": "The ID for the author of the object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "The title for the post"
        },
        {
          "displayName": "Content",
          "name": "content",
          "type": "string",
          "default": "",
          "description": "The content for the post"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "An alphanumeric identifier for the object unique to its type"
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "A password to protect access to the content and excerpt"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Future",
              "value": "future"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "draft",
          "description": "A named status for the post"
        },
        {
          "displayName": "Date",
          "name": "date",
          "type": "dateTime",
          "default": "",
          "description": "The date the post was published, in the site's timezone"
        },
        {
          "displayName": "Comment Status",
          "name": "commentStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the post"
        },
        {
          "displayName": "Ping Status",
          "name": "pingStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the post"
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "options": [
            {
              "name": "Aside",
              "value": "aside"
            },
            {
              "name": "Audio",
              "value": "audio"
            },
            {
              "name": "Chat",
              "value": "chat"
            },
            {
              "name": "Gallery",
              "value": "gallery"
            },
            {
              "name": "Image",
              "value": "image"
            },
            {
              "name": "Link",
              "value": "link"
            },
            {
              "name": "Quote",
              "value": "quote"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Video",
              "value": "video"
            }
          ],
          "default": "standard",
          "description": "The format of the post"
        },
        {
          "displayName": "Sticky",
          "name": "sticky",
          "type": "boolean",
          "default": false,
          "description": "Whether or not the object should be treated as sticky"
        },
        {
          "displayName": "Category Names or IDs",
          "name": "categories",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "default": [],
          "description": "The terms assigned to the object in the category taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The terms assigned to the object in the post_tag taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Template",
          "name": "postTemplate",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Elementor Template",
                  "name": "elementor",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether site uses elementor page builder"
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "string",
                  "default": "",
                  "description": "The theme file to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        false
                      ]
                    }
                  }
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "options",
                  "options": [
                    {
                      "name": "Standard",
                      "value": ""
                    },
                    {
                      "name": "Elementor Canvas",
                      "value": "elementor_canvas"
                    },
                    {
                      "name": "Elementor Header Footer",
                      "value": "elementor_header_footer"
                    },
                    {
                      "name": "Elementor Theme",
                      "value": "elementor_theme"
                    }
                  ],
                  "default": "",
                  "description": "The Elementor template to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        true
                      ]
                    }
                  }
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the object",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "The password for the post if it is password protected"
        },
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "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": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "After",
          "name": "after",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to posts published after a given ISO8601 compliant date"
        },
        {
          "displayName": "Author Names or IDs",
          "name": "author",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getAuthors"
          },
          "description": "Limit result set to posts assigned to specific authors. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Before",
          "name": "before",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to posts published before a given ISO8601 compliant date"
        },
        {
          "displayName": "Category Names or IDs",
          "name": "categories",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        },
        {
          "displayName": "Exclude Categories",
          "name": "excludedCategories",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCategories"
          },
          "description": "Limit result set to all items except those that have the specified term assigned in the categories taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Exclude Tags",
          "name": "excludedTags",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "description": "Limit result set to all items except those that have the specified term assigned in the tags taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Order sort attribute ascending or descending"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "options",
          "options": [
            {
              "name": "Author",
              "value": "author"
            },
            {
              "name": "Date",
              "value": "date"
            },
            {
              "name": "ID",
              "value": "id"
            },
            {
              "name": "Include",
              "value": "include"
            },
            {
              "name": "Include Slugs",
              "value": "include_slugs"
            },
            {
              "name": "Modified",
              "value": "modified"
            },
            {
              "name": "Parent",
              "value": "parent"
            },
            {
              "name": "Relevance",
              "value": "relevance"
            },
            {
              "name": "Slug",
              "value": "slug"
            },
            {
              "name": "Title",
              "value": "title"
            }
          ],
          "default": "id",
          "description": "Sort collection by object attribute"
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Limit results to those matching a string"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Future",
              "value": "future"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "publish",
          "description": "The status of the post"
        },
        {
          "displayName": "Sticky",
          "name": "sticky",
          "type": "boolean",
          "default": false,
          "description": "Whether to limit the result set to items that are sticky"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "description": "Limit result set to all items that have the specified term assigned in the tags taxonomy. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the object",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Force",
          "name": "force",
          "type": "boolean",
          "default": false,
          "description": "Whether to bypass trash and force deletion"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a page",
          "action": "Create a page"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a page",
          "action": "Get a page"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many pages",
          "action": "Get many pages"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a page",
          "action": "Update a page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "The title for the page",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Author Name or ID",
          "name": "authorId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAuthors"
          },
          "default": "",
          "description": "The ID for the author of the object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Parent ID",
          "name": "parent",
          "type": "number",
          "default": "",
          "description": "The ID for the parent of the post"
        },
        {
          "displayName": "Content",
          "name": "content",
          "type": "string",
          "default": "",
          "description": "The content for the page"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "An alphanumeric identifier for the object unique to its type"
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "A password to protect access to the content and excerpt"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Future",
              "value": "future"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "draft",
          "description": "A named status for the page"
        },
        {
          "displayName": "Comment Status",
          "name": "commentStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the page"
        },
        {
          "displayName": "Ping Status",
          "name": "pingStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "If the a message should be send to announce the page"
        },
        {
          "displayName": "Template",
          "name": "pageTemplate",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Elementor Template",
                  "name": "elementor",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether site uses elementor page builder"
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "string",
                  "default": "",
                  "description": "The theme file to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        false
                      ]
                    }
                  }
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "options",
                  "options": [
                    {
                      "name": "Standard",
                      "value": ""
                    },
                    {
                      "name": "Elementor Canvas",
                      "value": "elementor_canvas"
                    },
                    {
                      "name": "Elementor Header Footer",
                      "value": "elementor_header_footer"
                    },
                    {
                      "name": "Elementor Theme",
                      "value": "elementor_theme"
                    }
                  ],
                  "default": "",
                  "description": "The Elementor template to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        true
                      ]
                    }
                  }
                }
              ]
            }
          ]
        },
        {
          "displayName": "Menu Order",
          "name": "menuOrder",
          "type": "number",
          "default": 0,
          "description": "The order of the page in relation to other pages"
        },
        {
          "displayName": "Featured Media ID",
          "name": "featuredMediaId",
          "type": "number",
          "default": "",
          "description": "The ID of the featured media for the page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Page ID",
      "name": "pageId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the object",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Author Name or ID",
          "name": "authorId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAuthors"
          },
          "default": "",
          "description": "The ID for the author of the object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Parent ID",
          "name": "parent",
          "type": "number",
          "default": "",
          "description": "The ID for the parent of the post"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "The title for the page"
        },
        {
          "displayName": "Content",
          "name": "content",
          "type": "string",
          "default": "",
          "description": "The content for the page"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "An alphanumeric identifier for the object unique to its type"
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "A password to protect access to the content and excerpt"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Future",
              "value": "future"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "draft",
          "description": "A named status for the page"
        },
        {
          "displayName": "Comment Status",
          "name": "commentStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the page"
        },
        {
          "displayName": "Ping Status",
          "name": "pingStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Close",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the page"
        },
        {
          "displayName": "Template",
          "name": "pageTemplate",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Values",
              "name": "values",
              "values": [
                {
                  "displayName": "Elementor Template",
                  "name": "elementor",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether site uses elementor page builder"
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "string",
                  "default": "",
                  "description": "The theme file to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        false
                      ]
                    }
                  }
                },
                {
                  "displayName": "Template",
                  "name": "template",
                  "type": "options",
                  "options": [
                    {
                      "name": "Standard",
                      "value": ""
                    },
                    {
                      "name": "Elementor Canvas",
                      "value": "elementor_canvas"
                    },
                    {
                      "name": "Elementor Header Footer",
                      "value": "elementor_header_footer"
                    },
                    {
                      "name": "Elementor Theme",
                      "value": "elementor_theme"
                    }
                  ],
                  "default": "",
                  "description": "The Elementor template to use",
                  "displayOptions": {
                    "show": {
                      "elementor": [
                        true
                      ]
                    }
                  }
                }
              ]
            }
          ]
        },
        {
          "displayName": "Menu Order",
          "name": "menuOrder",
          "type": "number",
          "default": 0,
          "description": "The order of the page in relation to other pages"
        },
        {
          "displayName": "Comment Status",
          "name": "commentStatus",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Closed",
              "value": "closed"
            }
          ],
          "default": "open",
          "description": "Whether or not comments are open on the page"
        },
        {
          "displayName": "Featured Media ID",
          "name": "featuredMediaId",
          "type": "number",
          "default": "",
          "description": "The ID of the featured media for the page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Page ID",
      "name": "pageId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the object",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "The password for the page if it is password protected"
        },
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "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": [
            "page"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "After",
          "name": "after",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to pages published after a given ISO8601 compliant date"
        },
        {
          "displayName": "Author Names or IDs",
          "name": "author",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getAuthors"
          },
          "description": "Limit result set to pages assigned to specific authors. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Before",
          "name": "before",
          "type": "dateTime",
          "default": "",
          "description": "Limit response to pages published before a given ISO8601 compliant date"
        },
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        },
        {
          "displayName": "Menu Order",
          "name": "menuOrder",
          "type": "number",
          "default": 0,
          "description": "Limit result set to items with a specific menu order value"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Order sort attribute ascending or descending"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "options",
          "options": [
            {
              "name": "Author",
              "value": "author"
            },
            {
              "name": "Date",
              "value": "date"
            },
            {
              "name": "ID",
              "value": "id"
            },
            {
              "name": "Include",
              "value": "include"
            },
            {
              "name": "Include Slugs",
              "value": "include_slugs"
            },
            {
              "name": "Modified",
              "value": "modified"
            },
            {
              "name": "Parent",
              "value": "parent"
            },
            {
              "name": "Relevance",
              "value": "relevance"
            },
            {
              "name": "Slug",
              "value": "slug"
            },
            {
              "name": "Title",
              "value": "title"
            }
          ],
          "default": "id",
          "description": "Sort collection by object attribute"
        },
        {
          "displayName": "Page",
          "name": "page",
          "type": "number",
          "default": 1,
          "description": "Current page of the collection"
        },
        {
          "displayName": "Parent Page ID",
          "name": "parent",
          "type": "number",
          "default": "",
          "description": "Limit result set to items with a particular parent page ID"
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Limit results to those matching a string"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Future",
              "value": "future"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Publish",
              "value": "publish"
            }
          ],
          "default": "publish",
          "description": "The status of the page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Page ID",
      "name": "pageId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the object",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Force",
          "name": "force",
          "type": "boolean",
          "default": false,
          "description": "Whether to bypass trash and force deletion"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "page"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a user",
          "action": "Create a user"
        },
        {
          "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"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "Login name for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Display name for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "description": "First name for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "description": "Last name for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "description": "Password for the user (never included)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "URL of the user"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the user"
        },
        {
          "displayName": "Nickname",
          "name": "nickname",
          "type": "string",
          "default": "",
          "description": "The nickname for the user"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "An alphanumeric identifier for the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Username",
          "name": "username",
          "type": "string",
          "default": "",
          "description": "Login name for the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Display name for the user"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name for the user"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name for the user"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address for the user"
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "Password for the user (never included)"
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "URL of the user"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the user"
        },
        {
          "displayName": "Nickname",
          "name": "nickname",
          "type": "string",
          "default": "",
          "description": "The nickname for the user"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "An alphanumeric identifier for the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        }
      ],
      "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": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Context",
          "name": "context",
          "type": "options",
          "options": [
            {
              "name": "View",
              "value": "view"
            },
            {
              "name": "Embed",
              "value": "embed"
            },
            {
              "name": "Edit",
              "value": "edit"
            }
          ],
          "default": "view",
          "description": "Scope under which the request is made; determines fields present in response"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "options",
          "options": [
            {
              "name": "Email",
              "value": "email"
            },
            {
              "name": "ID",
              "value": "id"
            },
            {
              "name": "Include",
              "value": "include"
            },
            {
              "name": "Include Slugs",
              "value": "include_slugs"
            },
            {
              "name": "Name",
              "value": "name"
            },
            {
              "name": "Registered Date",
              "value": "registered_date"
            },
            {
              "name": "Slug",
              "value": "slug"
            },
            {
              "name": "URL",
              "value": "url"
            }
          ],
          "default": "id",
          "description": "Sort collection by object attribute"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc",
          "description": "Order sort attribute ascending or descending"
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Limit results to those matching a string"
        },
        {
          "displayName": "Who",
          "name": "who",
          "type": "options",
          "options": [
            {
              "name": "Authors",
              "value": "authors"
            }
          ],
          "default": "authors",
          "description": "Limit result set to users who are considered authors"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Reassign",
      "name": "reassign",
      "type": "string",
      "default": "",
      "description": "Reassign the deleted user's posts and links to this user ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Workable Trigger node documentation
  description: Learn how to use the Workable Trigger node in n8n. Follow technical documentation to integrate Workable Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Workable Trigger node

  Use the Workable Trigger node to respond to events in the [Workable](https://www.workable.com/){:target=_blank .external-link} recruiting platform and integrate Workable with other applications. n8n has built-in support for a wide range of Workable events, including candidate created and moved.

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

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

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

  ## Events

  - **Candidate Created**
  - **Candidate Moved**

  ## Related resources

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

  Refer to [Workable's API documentation](https://developers.workable.com/){:target=_blank .external-link} for details about using the service.

properties_schema:
  [
    {
      "displayName": "Trigger On",
      "name": "triggerOn",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Candidate Created",
          "value": "candidateCreated"
        },
        {
          "name": "Candidate Moved",
          "value": "candidateMoved"
        }
      ],
      "required": true
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Job Name or ID",
          "name": "job",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getJobs"
          },
          "default": "",
          "description": "Get notifications only for one job. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stage",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getStages"
          },
          "default": "",
          "description": "Get notifications for specific stages. e.g. 'hired'. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ]
    }
  ]


node_type: nodes-base.workflowTrigger
package_name: n8n-nodes-base
display_name: Workflow Trigger
description: Triggers based on various lifecycle events, like when a workflow is activated
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Workflow Trigger node documentation
  description: Learn how to use the Workflow Trigger node in n8n. Follow technical documentation to integrate Workflow Trigger node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Workflow Trigger node

  The Workflow Trigger node gets triggered when a workflow is updated or activated.

  /// warning | Deprecated
  n8n has deprecated the Workflow Trigger node and moved its functionality to the [n8n Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.n8ntrigger.md).
  ///

  /// note | Keep in mind
  If you want to use the Workflow Trigger node for a workflow, add the node to the workflow. You don't have to create a separate workflow.
  ///

  The Workflow Trigger node gets triggered for the workflow that it gets added to. You can use the Workflow Trigger node to trigger a workflow to notify the state of the workflow.

  ## Node parameters

  The node includes a single parameter to identify the **Events** that should trigger it. Choose from these events:

  - **Active Workflow Updated**: If you select this event, the node triggers when this workflow is updated.
  - **Workflow Activated**: If you select this event, the node triggers when this workflow is activated.

  You can select one or both of these events.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "This node is deprecated and would not be updated in the future. Please use 'n8n Trigger' node instead.",
      "name": "oldVersionNotice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "Specifies under which conditions an execution should happen:\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><b>Active Workflow Updated</b>: Triggers when this workflow is updated</li>\n\t\t\t\t\t\t<li><b>Workflow Activated</b>: Triggers when this workflow is activated</li>\n\t\t\t\t\t</ul>",
      "options": [
        {
          "name": "Active Workflow Updated",
          "value": "update",
          "description": "Triggers when this workflow is updated"
        },
        {
          "name": "Workflow Activated",
          "value": "activate",
          "description": "Triggers when this workflow is activated"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.writeBinaryFile
package_name: n8n-nodes-base
display_name: Write Binary File
description: Writes a binary file to disk
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
properties_schema:
  [
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Path to which the file should be written",
      "required": true
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property which contains the data for the file to be written",
      "required": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Append",
          "name": "append",
          "type": "boolean",
          "default": false,
          "description": "Whether to append to an existing file"
        }
      ]
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Wufoo Trigger node documentation
  description: Learn how to use the Wufoo Trigger node in n8n. Follow technical documentation to integrate Wufoo Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Wufoo Trigger node

  [Wufoo](https://wufoo.com){:target=_blank .external-link} is an online form builder that helps you create custom HTML forms without writing code.

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

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

properties_schema:
  [
    {
      "displayName": "Forms Name or ID",
      "name": "form",
      "type": "options",
      "default": "",
      "description": "The form upon which will trigger this node when a new entry is made. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getForms"
      }
    },
    {
      "displayName": "Only Answers",
      "name": "onlyAnswers",
      "type": "boolean",
      "default": true,
      "description": "Whether to return only the answers of the form and not any of the other data"
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Xero node documentation
  description: Learn how to use the Xero node in n8n. Follow technical documentation to integrate Xero node into your workflows.
  contentType: [integration, reference]
  ---

  # Xero node

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

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

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

  ## Operations

  * Contact
      * Create a contact
      * Get a contact
      * Get all contacts
      * Update a contact
  * Invoice
      * Create a invoice
      * Get a invoice
      * Get all invoices
      * Update a invoice

  ## Templates and examples

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

  ## Related resources

  Refer to [Xero's API documentation](https://developer.xero.com/documentation/api/accounting/overview){:target=_blank .external-link} for more information about the service.

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "invoice",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a contact",
          "action": "Create 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": "Organization Name or ID",
      "name": "organizationId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Full name of contact/organisation",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Account Number",
          "name": "accountNumber",
          "type": "string",
          "default": "",
          "description": "A user defined account number"
        },
        {
          "displayName": "Addresses",
          "name": "addressesUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Address",
          "options": [
            {
              "name": "addressesValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "PO Box",
                      "value": "POBOX"
                    },
                    {
                      "name": "Street",
                      "value": "STREET"
                    }
                  ],
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "line2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Region",
                  "name": "region",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Attention To",
                  "name": "attentionTo",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Bank Account Details",
          "name": "bankAccountDetails",
          "type": "string",
          "default": "",
          "description": "Bank account number of contact"
        },
        {
          "displayName": "Contact Number",
          "name": "contactNumber",
          "type": "string",
          "default": "",
          "description": "This field is read only on the Xero contact screen, used to identify contacts in external systems"
        },
        {
          "displayName": "Contact Status",
          "name": "contactStatus",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE",
              "description": "The Contact is active and can be used in transactions"
            },
            {
              "name": "Archived",
              "value": "ARCHIVED",
              "description": "The Contact is archived and can no longer be used in transactions"
            },
            {
              "name": "GDPR Request",
              "value": "GDPRREQUEST",
              "description": "The Contact is the subject of a GDPR erasure request"
            }
          ],
          "default": "",
          "description": "Current status of a contact - see contact status types"
        },
        {
          "displayName": "Default Currency",
          "name": "defaultCurrency",
          "type": "string",
          "default": "",
          "description": "Default currency for raising invoices against contact"
        },
        {
          "displayName": "Email",
          "name": "emailAddress",
          "type": "string",
          "default": "",
          "description": "Email address of contact person (umlauts not supported) (max length = 255)"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of contact person (max length = 255)"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of contact person (max length = 255)"
        },
        {
          "displayName": "Phones",
          "name": "phonesUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Phone",
          "options": [
            {
              "name": "phonesValues",
              "displayName": "Phones",
              "values": [
                {
                  "displayName": "Type",
                  "name": "phoneType",
                  "type": "options",
                  "options": [
                    {
                      "name": "Default",
                      "value": "DEFAULT"
                    },
                    {
                      "name": "DDI",
                      "value": "DDI"
                    },
                    {
                      "name": "Mobile",
                      "value": "MOBILE"
                    },
                    {
                      "name": "Fax",
                      "value": "FAX"
                    }
                  ],
                  "default": ""
                },
                {
                  "displayName": "Number",
                  "name": "phoneNumber",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Area Code",
                  "name": "phoneAreaCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Code",
                  "name": "phoneCountryCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Purchase Default Account Code Name or ID",
          "name": "purchasesDefaultAccountCode",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAccountCodes"
          },
          "default": "",
          "description": "The default purchases account code for contacts. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Sales Default Account Code Name or ID",
          "name": "salesDefaultAccountCode",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAccountCodes"
          },
          "default": "",
          "description": "The default sales account code for contacts. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Skype",
          "name": "skypeUserName",
          "type": "string",
          "default": "",
          "description": "Skype user name of contact"
        },
        {
          "displayName": "Tax Number",
          "name": "taxNumber",
          "type": "string",
          "default": "",
          "description": "Tax number of contact"
        },
        {
          "displayName": "Xero Network Key",
          "name": "xeroNetworkKey",
          "type": "string",
          "default": "",
          "description": "Store XeroNetworkKey for contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Archived",
          "name": "includeArchived",
          "type": "boolean",
          "default": false,
          "description": "Whether contacts with a status of ARCHIVED will be included in the response"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "string",
          "placeholder": "contactID",
          "default": "",
          "description": "Order by any element returned"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "Asc",
              "value": "ASC"
            },
            {
              "name": "Desc",
              "value": "DESC"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Where",
          "name": "where",
          "type": "string",
          "placeholder": "EmailAddress!=null&&EmailAddress.StartsWith(\"boom\")",
          "default": "",
          "description": "The where parameter allows you to filter on endpoints and elements that don't have explicit parameters. <a href=\"https://developer.xero.com/documentation/api/requests-and-responses#get-modified\">Examples Here</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Account Number",
          "name": "accountNumber",
          "type": "string",
          "default": "",
          "description": "A user defined account number"
        },
        {
          "displayName": "Addresses",
          "name": "addressesUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Address",
          "options": [
            {
              "name": "addressesValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "PO Box",
                      "value": "POBOX"
                    },
                    {
                      "name": "Street",
                      "value": "STREET"
                    }
                  ],
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "line2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Region",
                  "name": "region",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Attention To",
                  "name": "attentionTo",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Bank Account Details",
          "name": "bankAccountDetails",
          "type": "string",
          "default": "",
          "description": "Bank account number of contact"
        },
        {
          "displayName": "Contact Number",
          "name": "contactNumber",
          "type": "string",
          "default": "",
          "description": "This field is read only on the Xero contact screen, used to identify contacts in external systems"
        },
        {
          "displayName": "Contact Status",
          "name": "contactStatus",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE",
              "description": "The Contact is active and can be used in transactions"
            },
            {
              "name": "Archived",
              "value": "ARCHIVED",
              "description": "The Contact is archived and can no longer be used in transactions"
            },
            {
              "name": "GDPR Request",
              "value": "GDPRREQUEST",
              "description": "The Contact is the subject of a GDPR erasure request"
            }
          ],
          "default": "",
          "description": "Current status of a contact - see contact status types"
        },
        {
          "displayName": "Default Currency",
          "name": "defaultCurrency",
          "type": "string",
          "default": "",
          "description": "Default currency for raising invoices against contact"
        },
        {
          "displayName": "Email",
          "name": "emailAddress",
          "type": "string",
          "default": "",
          "description": "Email address of contact person (umlauts not supported) (max length = 255)"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of contact person (max length = 255)"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of contact person (max length = 255)"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Full name of contact/organisation"
        },
        {
          "displayName": "Phones",
          "name": "phonesUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "placeholder": "Add Phone",
          "options": [
            {
              "name": "phonesValues",
              "displayName": "Phones",
              "values": [
                {
                  "displayName": "Type",
                  "name": "phoneType",
                  "type": "options",
                  "options": [
                    {
                      "name": "Default",
                      "value": "DEFAULT"
                    },
                    {
                      "name": "DDI",
                      "value": "DDI"
                    },
                    {
                      "name": "Mobile",
                      "value": "MOBILE"
                    },
                    {
                      "name": "Fax",
                      "value": "FAX"
                    }
                  ],
                  "default": ""
                },
                {
                  "displayName": "Number",
                  "name": "phoneNumber",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Area Code",
                  "name": "phoneAreaCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Code",
                  "name": "phoneCountryCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Purchase Default Account Code Name or ID",
          "name": "purchasesDefaultAccountCode",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAccountCodes"
          },
          "default": "",
          "description": "The default purchases account code for contacts. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Sales Default Account Code Name or ID",
          "name": "salesDefaultAccountCode",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAccountCodes"
          },
          "default": "",
          "description": "The default sales account code for contacts. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Skype",
          "name": "skypeUserName",
          "type": "string",
          "default": "",
          "description": "Skype user name of contact"
        },
        {
          "displayName": "Tax Number",
          "name": "taxNumber",
          "type": "string",
          "default": "",
          "description": "Tax number of contact"
        },
        {
          "displayName": "Xero Network Key",
          "name": "xeroNetworkKey",
          "type": "string",
          "default": "",
          "description": "Store XeroNetworkKey for contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a invoice",
          "action": "Create an invoice"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a invoice",
          "action": "Get an invoice"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many invoices",
          "action": "Get many invoices"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a invoice",
          "action": "Update an invoice"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "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": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "",
      "description": "Invoice Type",
      "options": [
        {
          "name": "Bill",
          "value": "ACCPAY",
          "description": "Accounts Payable or supplier invoice"
        },
        {
          "name": "Sales Invoice",
          "value": "ACCREC",
          "description": "Accounts Receivable or customer invoice"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Line Items",
      "name": "lineItemsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Line item data",
      "options": [
        {
          "name": "lineItemsValues",
          "displayName": "Line Item",
          "values": [
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": "",
              "description": "A line item with just a description"
            },
            {
              "displayName": "Quantity",
              "name": "quantity",
              "type": "number",
              "default": 1,
              "typeOptions": {
                "minValue": 1
              },
              "description": "LineItem Quantity"
            },
            {
              "displayName": "Unit Amount",
              "name": "unitAmount",
              "type": "string",
              "default": "",
              "description": "Lineitem unit amount. By default, unit amount will be rounded to two decimal places."
            },
            {
              "displayName": "Item Code Name or ID",
              "name": "itemCode",
              "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": "getItemCodes",
                "loadOptionsDependsOn": [
                  "organizationId"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Account Code Name or ID",
              "name": "accountCode",
              "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": "getAccountCodes",
                "loadOptionsDependsOn": [
                  "organizationId"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Tax Type",
              "name": "taxType",
              "type": "options",
              "options": [
                {
                  "name": "Tax on Purchases",
                  "value": "INPUT"
                },
                {
                  "name": "Tax Exempt",
                  "value": "NONE"
                },
                {
                  "name": "Tax on Sales",
                  "value": "OUTPUT"
                },
                {
                  "name": "Sales Tax on Imports",
                  "value": "GSTONIMPORTS"
                }
              ],
              "default": "",
              "required": true
            },
            {
              "displayName": "Tax Amount",
              "name": "taxAmount",
              "type": "string",
              "default": "",
              "description": "The tax amount is auto calculated as a percentage of the line amount based on the tax rate"
            },
            {
              "displayName": "Line Amount",
              "name": "lineAmount",
              "type": "string",
              "default": "",
              "description": "The line amount reflects the discounted price if a DiscountRate has been used"
            },
            {
              "displayName": "Discount Rate",
              "name": "discountRate",
              "type": "string",
              "default": "",
              "description": "Percentage discount or discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Branding Theme Name or ID",
          "name": "brandingThemeId",
          "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": "getBrandingThemes",
            "loadOptionsDependsOn": [
              "organizationId"
            ]
          },
          "default": ""
        },
        {
          "displayName": "Currency Name or ID",
          "name": "currency",
          "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": "getCurrencies",
            "loadOptionsDependsOn": [
              "organizationId"
            ]
          },
          "default": ""
        },
        {
          "displayName": "Currency Rate",
          "name": "currencyRate",
          "type": "string",
          "default": "",
          "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used."
        },
        {
          "displayName": "Date",
          "name": "date",
          "type": "dateTime",
          "default": "",
          "description": "Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation."
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "description": "Date invoice is due - YYYY-MM-DD"
        },
        {
          "displayName": "Expected Payment Date",
          "name": "expectedPaymentDate",
          "type": "dateTime",
          "default": "",
          "description": "Shown on sales invoices (Accounts Receivable) when this has been set"
        },
        {
          "displayName": "Invoice Number",
          "name": "invoiceNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Line Amount Type",
          "name": "lineAmountType",
          "type": "options",
          "options": [
            {
              "name": "Exclusive",
              "value": "Exclusive",
              "description": "Line items are exclusive of tax"
            },
            {
              "name": "Inclusive",
              "value": "Inclusive",
              "description": "Line items are inclusive tax"
            },
            {
              "name": "NoTax",
              "value": "NoTax",
              "description": "Line have no tax"
            }
          ],
          "default": "Exclusive"
        },
        {
          "displayName": "Planned Payment Date",
          "name": "plannedPaymentDate",
          "type": "dateTime",
          "default": "",
          "description": "Shown on bills (Accounts Payable) when this has been set"
        },
        {
          "displayName": "Reference",
          "name": "reference",
          "type": "string",
          "default": "",
          "description": "ACCREC only - additional reference number (max length = 255)"
        },
        {
          "displayName": "Send To Contact",
          "name": "sendToContact",
          "type": "boolean",
          "default": false,
          "description": "Whether the invoice in the Xero app should be marked as \"sent\". This can be set only on invoices that have been approved."
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "DRAFT"
            },
            {
              "name": "Submitted",
              "value": "SUBMITTED"
            },
            {
              "name": "Authorised",
              "value": "AUTHORISED"
            }
          ],
          "default": "DRAFT"
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "URL link to a source document - shown as \"Go to [appName]\" in the Xero app"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "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": [
            "invoice"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Branding Theme Name or ID",
          "name": "brandingThemeId",
          "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": "getBrandingThemes",
            "loadOptionsDependsOn": [
              "organizationId"
            ]
          },
          "default": ""
        },
        {
          "displayName": "Contact ID",
          "name": "contactId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Currency Name or ID",
          "name": "currency",
          "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": "getCurrencies",
            "loadOptionsDependsOn": [
              "organizationId"
            ]
          },
          "default": ""
        },
        {
          "displayName": "Currency Rate",
          "name": "currencyRate",
          "type": "string",
          "default": "",
          "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used."
        },
        {
          "displayName": "Date",
          "name": "date",
          "type": "dateTime",
          "default": "",
          "description": "Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation."
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "description": "Date invoice is due - YYYY-MM-DD"
        },
        {
          "displayName": "Expected Payment Date",
          "name": "expectedPaymentDate",
          "type": "dateTime",
          "default": "",
          "description": "Shown on sales invoices (Accounts Receivable) when this has been set"
        },
        {
          "displayName": "Invoice Number",
          "name": "invoiceNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Line Amount Type",
          "name": "lineAmountType",
          "type": "options",
          "options": [
            {
              "name": "Exclusive",
              "value": "Exclusive",
              "description": "Line items are exclusive of tax"
            },
            {
              "name": "Inclusive",
              "value": "Inclusive",
              "description": "Line items are inclusive tax"
            },
            {
              "name": "NoTax",
              "value": "NoTax",
              "description": "Line have no tax"
            }
          ],
          "default": "Exclusive"
        },
        {
          "displayName": "Line Items",
          "name": "lineItemsUi",
          "placeholder": "Add Line Item",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Line item data",
          "options": [
            {
              "name": "lineItemsValues",
              "displayName": "Line Item",
              "values": [
                {
                  "displayName": "Line Item ID",
                  "name": "lineItemId",
                  "type": "string",
                  "default": "",
                  "description": "The Xero generated identifier for a LineItem"
                },
                {
                  "displayName": "Description",
                  "name": "description",
                  "type": "string",
                  "default": "",
                  "description": "A line item with just a description"
                },
                {
                  "displayName": "Quantity",
                  "name": "quantity",
                  "type": "number",
                  "default": 1,
                  "typeOptions": {
                    "minValue": 1
                  },
                  "description": "LineItem Quantity"
                },
                {
                  "displayName": "Unit Amount",
                  "name": "unitAmount",
                  "type": "string",
                  "default": "",
                  "description": "Lineitem unit amount. By default, unit amount will be rounded to two decimal places."
                },
                {
                  "displayName": "Item Code Name or ID",
                  "name": "itemCode",
                  "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": "getItemCodes",
                    "loadOptionsDependsOn": [
                      "organizationId"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Account Code Name or ID",
                  "name": "accountCode",
                  "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": "getAccountCodes",
                    "loadOptionsDependsOn": [
                      "organizationId"
                    ]
                  },
                  "default": ""
                },
                {
                  "displayName": "Tax Type",
                  "name": "taxType",
                  "type": "options",
                  "options": [
                    {
                      "name": "Tax on Purchases",
                      "value": "INPUT"
                    },
                    {
                      "name": "Tax Exempt",
                      "value": "NONE"
                    },
                    {
                      "name": "Tax on Sales",
                      "value": "OUTPUT"
                    },
                    {
                      "name": "Sales Tax on Imports",
                      "value": "GSTONIMPORTS"
                    }
                  ],
                  "default": "",
                  "required": true
                },
                {
                  "displayName": "Tax Amount",
                  "name": "taxAmount",
                  "type": "string",
                  "default": "",
                  "description": "The tax amount is auto calculated as a percentage of the line amount based on the tax rate"
                },
                {
                  "displayName": "Line Amount",
                  "name": "lineAmount",
                  "type": "string",
                  "default": "",
                  "description": "The line amount reflects the discounted price if a DiscountRate has been used"
                },
                {
                  "displayName": "Discount Rate",
                  "name": "discountRate",
                  "type": "string",
                  "default": "",
                  "description": "Percentage discount or discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts."
                }
              ]
            }
          ]
        },
        {
          "displayName": "Planned Payment Date",
          "name": "plannedPaymentDate",
          "type": "dateTime",
          "default": "",
          "description": "Shown on bills (Accounts Payable) when this has been set"
        },
        {
          "displayName": "Reference",
          "name": "reference",
          "type": "string",
          "default": "",
          "description": "ACCREC only - additional reference number (max length = 255)"
        },
        {
          "displayName": "Send To Contact",
          "name": "sendToContact",
          "type": "boolean",
          "default": false,
          "description": "Whether the invoice in the Xero app should be marked as \"sent\". This can be set only on invoices that have been approved."
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": "DRAFT"
            },
            {
              "name": "Submitted",
              "value": "SUBMITTED"
            },
            {
              "name": "Authorised",
              "value": "AUTHORISED"
            }
          ],
          "default": "DRAFT"
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "URL link to a source document - shown as \"Go to [appName]\" in the Xero app"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "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": [
            "invoice"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Organization Name or ID",
      "name": "organizationId",
      "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": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTenants"
      }
    },
    {
      "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": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Created By My App",
          "name": "createdByMyApp",
          "type": "boolean",
          "default": false,
          "description": "Whether you'll only retrieve Invoices created by your app"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "string",
          "placeholder": "InvoiceID",
          "default": "",
          "description": "Order by any element returned"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "Asc",
              "value": "ASC"
            },
            {
              "name": "Desc",
              "value": "DESC"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Statuses",
          "name": "statuses",
          "type": "multiOptions",
          "options": [
            {
              "name": "Draft",
              "value": "DRAFT"
            },
            {
              "name": "Submitted",
              "value": "SUBMITTED"
            },
            {
              "name": "Authorised",
              "value": "AUTHORISED"
            }
          ],
          "default": []
        },
        {
          "displayName": "Where",
          "name": "where",
          "type": "string",
          "placeholder": "EmailAddress!=null&&EmailAddress.StartsWith(\"boom\")",
          "default": "",
          "description": "The where parameter allows you to filter on endpoints and elements that don't have explicit parameters. <a href=\"https://developer.xero.com/documentation/api/requests-and-responses#get-modified\">Examples Here</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create 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.xml
package_name: n8n-nodes-base
display_name: XML
description: Convert data from and to XML
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

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

  # XML

  Use the XML node to convert data from and to XML.

  /// note | Binary files
  If your XML is within a binary file, use the [Extract from File](/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md) node to convert it to text first.
  ///

  ## Node parameters

  - **Mode**: The format the data should be converted from and to.
  	- **JSON to XML**: Converts data from JSON to XML.
      - **XML to JSON**: Converts data from XML to JSON.
  - **Property Name**: Enter the name of the property which contains the data to convert.

  ## Node options

  These options are available regardless of the **Mode** you select:

  - **Attribute Key**: Enter the prefix used to access the attributes. Default is `$`.
  - **Character Key**: Enter the prefix used to access the character content. Default is `_`.

  All other options depend on the selected **Mode**.

  ### JSON to XML options

  These options only appear if you select **JSON to XML** as the **Mode**:

  - **Allow Surrogate Chars**: Set whether to allow using characters from the Unicode surrogate blocks (turned on) or not (turned off).
  - **Cdata**: Set whether to wrap text nodes in `<![CDATA[ ... ]]>` instead of escaping when it's required (turned on) or not (turned off).
      * Turning this option on doesn't add `<![CDATA[ ... ]]>` if it's not required.
  - **Headless**: Set whether to omit the XML header (turned on) or include it (turned off).
  - **Root Name**: Enter the root element name to use.

  ### XML to JSON options

  These options only appear if you select **XML to JSON** as the **Mode**:

  - **Explicit Array**: Set whether to put child nodes in an array (turned on) or create an array only if there's more than one child node (turned off).
  - **Explicit Root**: Set whether to get the root node in the resulting object (turned on) or not (turned off).
  - **Ignore Attributes**: Set whether to ignore all XML attributes and only create text nodes (turned on) or not (turned off).
  - **Merge Attributes**: Set whether to merge attributes and child elements as properties of the parent (turned on) or key attributes off a child attribute object (turned off). This option is ignored if **Ignore Attribute** is turned on.
  - **Normalize**: Set whether to trim whitespaces inside the text nodes (turned on) or not to trim them (turned off).
  - **Normalize Tags**: Set whether to normalize all tag names to lowercase (turned on) or keep tag names as-is (turned off).
  - **Trim**: Set whether to trim the whitespace at the beginning and end of text nodes (turned on) or to leave the whitespace as-is (turned off).

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "xmlToJson",
      "description": "From and to what format the data should be converted",
      "options": [
        {
          "name": "JSON to XML",
          "value": "jsonToxml",
          "description": "Converts data from JSON to XML"
        },
        {
          "name": "XML to JSON",
          "value": "xmlToJson",
          "description": "Converts data from XML to JSON"
        }
      ]
    },
    {
      "displayName": "If your XML is inside a binary file, use the 'Extract from File' node to convert it to text first",
      "name": "xmlNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "mode": [
            "xmlToJson"
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the property to which to contains the converted XML data",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "jsonToxml"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allow Surrogate Chars",
          "name": "allowSurrogateChars",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow using characters from the Unicode surrogate blocks"
        },
        {
          "displayName": "Attribute Key",
          "name": "attrkey",
          "type": "string",
          "default": "$",
          "description": "Prefix that is used to access the attributes"
        },
        {
          "displayName": "Cdata",
          "name": "cdata",
          "type": "boolean",
          "default": false,
          "description": "Whether to wrap text nodes in &lt;![CDATA[ ... ]]&gt; instead of escaping when necessary. Does not add &lt;![CDATA[ ... ]]&gt; if it is not required."
        },
        {
          "displayName": "Character Key",
          "name": "charkey",
          "type": "string",
          "default": "_",
          "description": "Prefix that is used to access the character content"
        },
        {
          "displayName": "Headless",
          "name": "headless",
          "type": "boolean",
          "default": false,
          "description": "Whether to omit the XML header"
        },
        {
          "displayName": "Root Name",
          "name": "rootName",
          "type": "string",
          "default": "root",
          "description": "Root element name to be used"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "jsonToxml"
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the property which contains the XML data to convert",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "xmlToJson"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attribute Key",
          "name": "attrkey",
          "type": "string",
          "default": "$",
          "description": "Prefix that is used to access the attributes"
        },
        {
          "displayName": "Character Key",
          "name": "charkey",
          "type": "string",
          "default": "_",
          "description": "Prefix that is used to access the character content"
        },
        {
          "displayName": "Explicit Array",
          "name": "explicitArray",
          "type": "boolean",
          "default": false,
          "description": "Whether to always put child nodes in an array if true; otherwise an array is created only if there is more than one"
        },
        {
          "displayName": "Explicit Root",
          "name": "explicitRoot",
          "type": "boolean",
          "default": true,
          "description": "Whether to set this if you want to get the root node in the resulting object"
        },
        {
          "displayName": "Ignore Attributes",
          "name": "ignoreAttrs",
          "type": "boolean",
          "default": false,
          "description": "Whether to ignore all XML attributes and only create text nodes"
        },
        {
          "displayName": "Merge Attributes",
          "name": "mergeAttrs",
          "type": "boolean",
          "default": true,
          "description": "Whether to merge attributes and child elements as properties of the parent, instead of keying attributes off a child attribute object. This option is ignored if ignoreAttrs is true."
        },
        {
          "displayName": "Normalize",
          "name": "normalize",
          "type": "boolean",
          "default": false,
          "description": "Whether to trim whitespaces inside text nodes"
        },
        {
          "displayName": "Normalize Tags",
          "name": "normalizeTags",
          "type": "boolean",
          "default": false,
          "description": "Whether to normalize all tag names to lowercase"
        },
        {
          "displayName": "Trim",
          "name": "trim",
          "type": "boolean",
          "default": false,
          "description": "Whether to trim the whitespace at the beginning and end of text nodes"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "xmlToJson"
          ]
        }
      }
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Yourls node documentation
  description: Learn how to use the Yourls node in n8n. Follow technical documentation to integrate Yourls node into your workflows.
  contentType: [integration, reference]
  ---

  # Yourls node

  Use the Yourls node to automate work in Yourls, and integrate Yourls with other applications. n8n has built-in support for a wide range of Yourls features, including expanding and shortening URLs. 

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

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

  ## Operations

  * URL
      * Expand a URL
      * Shorten a URL
      * Get stats about one short URL

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "url",
      "options": [
        {
          "name": "URL",
          "value": "url"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "shorten",
      "options": [
        {
          "name": "Expand",
          "value": "expand",
          "description": "Expand a URL",
          "action": "Expand a URL"
        },
        {
          "name": "Shorten",
          "value": "shorten",
          "description": "Shorten a URL",
          "action": "Shorten a URL"
        },
        {
          "name": "Stats",
          "value": "stats",
          "description": "Get stats about one short URL",
          "action": "Get stats for a URL"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "url"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "The URL to shorten",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "url"
          ],
          "operation": [
            "shorten"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Keyword",
          "name": "keyword",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title for custom short URLs"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "url"
          ],
          "operation": [
            "shorten"
          ]
        }
      }
    },
    {
      "displayName": "Short URL",
      "name": "shortUrl",
      "type": "string",
      "default": "",
      "description": "The short URL to expand",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "url"
          ],
          "operation": [
            "expand"
          ]
        }
      }
    },
    {
      "displayName": "Short URL",
      "name": "shortUrl",
      "type": "string",
      "default": "",
      "description": "The short URL for which to get stats",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "url"
          ],
          "operation": [
            "stats"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "expand",
      "name": "Expand",
      "description": "Expand a URL"
    },
    {
      "operation": "shorten",
      "name": "Shorten",
      "description": "Shorten a URL"
    },
    {
      "operation": "stats",
      "name": "Stats",
      "description": "Get stats about one short URL"
    }
  ]


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

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Zammad node documentation
  description: Learn how to use the Zammad node in n8n. Follow technical documentation to integrate Zammad node into your workflows.
  contentType: [integration, reference]
  ---

  # Zammad node

  Use the Zammad node to automate work in Zammad, and integrate Zammad with other applications. n8n has built-in support for a wide range of Zammad features, including creating, retrieving, and deleting groups and organizations.

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

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

  ## Operations

  * Group
      * Create
      * Delete
      * Get
      * Get many
      * Update
  * Organization
      * Create
      * Delete
      * Get
      * Get many
      * Update
  * Ticket
      * Create
      * Delete
      * Get
      * Get many
  * User
      * Create
      * Delete
      * Get
      * Get many
  	* Get self
      * Update

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "tokenAuth",
      "options": [
        {
          "name": "Basic Auth",
          "value": "basicAuth"
        },
        {
          "name": "Token Auth",
          "value": "tokenAuth"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Group",
          "value": "group"
        },
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Ticket",
          "value": "ticket"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a group",
          "action": "Create a group"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a group",
          "action": "Delete a group"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a group",
          "action": "Get a group"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many groups",
          "action": "Get many groups"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a group",
          "action": "Update a group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Group Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "group"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Group to update. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Group to delete. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Group to retrieve. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadGroupCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Notes",
          "name": "note",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadGroupCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Group Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notes",
          "name": "note",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "group"
          ]
        }
      }
    },
    {
      "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",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an organization",
          "action": "Create an organization"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an organization",
          "action": "Delete an organization"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve an organization",
          "action": "Get an organization"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many organizations",
          "action": "Get many organizations"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an organization",
          "action": "Update an organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Organization to update. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Organization to delete. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Organization to retrieve. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Shared",
          "name": "shared",
          "type": "boolean",
          "default": false,
          "description": "Whether the organization is shared with other instances"
        },
        {
          "displayName": "Domain",
          "name": "domain",
          "type": "string",
          "default": "",
          "description": "The domain associated with the organization"
        },
        {
          "displayName": "Domain Assignment",
          "name": "domain_assignment",
          "type": "boolean",
          "default": true,
          "description": "Whether to assign users based on their email domain"
        },
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": true,
          "description": "Whether the organization is active"
        },
        {
          "displayName": "VIP",
          "name": "vip",
          "type": "boolean",
          "default": false,
          "description": "Whether the organization is marked as VIP"
        },
        {
          "displayName": "Notes",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "A note about the organization"
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadOrganizationCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Shared",
          "name": "shared",
          "type": "boolean",
          "default": false,
          "description": "Whether the organization is shared with other instances"
        },
        {
          "displayName": "Domain",
          "name": "domain",
          "type": "string",
          "default": "",
          "description": "The domain associated with the organization"
        },
        {
          "displayName": "Domain Assignment",
          "name": "domain_assignment",
          "type": "boolean",
          "default": true,
          "description": "Whether to assign users based on their email domain"
        },
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": true,
          "description": "Whether the organization is active"
        },
        {
          "displayName": "VIP",
          "name": "vip",
          "type": "boolean",
          "default": false,
          "description": "Whether the organization is marked as VIP"
        },
        {
          "displayName": "Notes",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "A note about the organization"
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadOrganizationCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "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": [
            "organization"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a ticket",
          "action": "Create a ticket"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a ticket",
          "action": "Delete a ticket"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a ticket",
          "action": "Get a ticket"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many tickets",
          "action": "Get many tickets"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the ticket to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Group Name or ID",
      "name": "group",
      "type": "options",
      "default": "",
      "description": "Group that will own the ticket to create. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadGroupNames"
      }
    },
    {
      "displayName": "Customer Email Name or ID",
      "name": "customer",
      "type": "options",
      "default": "",
      "description": "Email address of the customer concerned in the ticket to create. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadCustomerEmails"
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Ticket to retrieve. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Ticket to delete. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Article",
      "name": "article",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Article Details",
          "name": "articleDetails",
          "values": [
            {
              "displayName": "Subject",
              "name": "subject",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Body",
              "name": "body",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Visibility",
              "name": "visibility",
              "type": "options",
              "default": "internal",
              "options": [
                {
                  "name": "External",
                  "value": "external",
                  "description": "Visible to customers"
                },
                {
                  "name": "Internal",
                  "value": "internal",
                  "description": "Visible to help desk"
                }
              ]
            },
            {
              "displayName": "Sender",
              "name": "sender",
              "type": "options",
              "options": [
                {
                  "name": "Agent",
                  "value": "Agent"
                },
                {
                  "name": "Customer",
                  "value": "Customer"
                },
                {
                  "name": "System",
                  "value": "System",
                  "description": "Only subject will be displayed in Zammad"
                }
              ],
              "default": "Agent"
            },
            {
              "displayName": "Article Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Chat",
                  "value": "chat"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "Fax",
                  "value": "fax"
                },
                {
                  "name": "Note",
                  "value": "note"
                },
                {
                  "name": "Phone",
                  "value": "phone"
                },
                {
                  "name": "SMS",
                  "value": "sms"
                }
              ],
              "default": "note"
            },
            {
              "displayName": "Reply To",
              "name": "reply_to",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadTicketCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a user",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a user",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many users",
          "action": "Get many users"
        },
        {
          "name": "Get Self",
          "value": "getSelf",
          "description": "Retrieve currently logged-in user",
          "action": "Get currently logged-in user"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "First Name",
      "name": "firstname",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastname",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "User to update. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "User to delete. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "User to retrieve. Specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Address",
          "name": "addressUi",
          "type": "fixedCollection",
          "placeholder": "Add Address",
          "default": {},
          "options": [
            {
              "displayName": "Address Details",
              "name": "addressDetails",
              "values": [
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": "",
                  "placeholder": "Berlin"
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "placeholder": "Germany"
                },
                {
                  "displayName": "Street & Number",
                  "name": "address",
                  "type": "string",
                  "default": "",
                  "placeholder": "Borsigstr. 27"
                },
                {
                  "displayName": "Zip Code",
                  "name": "zip",
                  "type": "string",
                  "default": "",
                  "placeholder": "10115"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadUserCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "string",
          "default": "",
          "placeholder": "Finance"
        },
        {
          "displayName": "Email Address",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": "",
          "placeholder": "+49 30 901820"
        },
        {
          "displayName": "Notes",
          "name": "note",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization Name or ID",
          "name": "organization",
          "type": "options",
          "description": "Name of the organization to assign to the user. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "loadOrganizations"
          }
        },
        {
          "displayName": "Phone (Landline)",
          "name": "phone",
          "type": "string",
          "default": "",
          "placeholder": "+49 30 901820"
        },
        {
          "displayName": "Phone (Mobile)",
          "name": "mobile",
          "type": "string",
          "default": "",
          "placeholder": "+49 1522 3433333"
        },
        {
          "displayName": "Verified",
          "name": "verified",
          "type": "boolean",
          "default": false,
          "description": "Whether the user has been verified"
        },
        {
          "displayName": "VIP",
          "name": "vip",
          "type": "boolean",
          "default": false,
          "description": "Whether the user is a Very Important Person"
        },
        {
          "displayName": "Website",
          "name": "web",
          "type": "string",
          "default": "",
          "placeholder": "https://n8n.io"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Address",
          "name": "addressUi",
          "type": "fixedCollection",
          "placeholder": "Add Address",
          "default": {},
          "options": [
            {
              "displayName": "Address Details",
              "name": "addressDetails",
              "values": [
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": "",
                  "placeholder": "Berlin"
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "placeholder": "Germany"
                },
                {
                  "displayName": "Street & Number",
                  "name": "address",
                  "type": "string",
                  "default": "",
                  "placeholder": "Borsigstr. 27"
                },
                {
                  "displayName": "Zip Code",
                  "name": "zip",
                  "type": "string",
                  "default": "",
                  "placeholder": "10115"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "customFieldPairs",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "name",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "loadUserCustomFields"
                  },
                  "default": "",
                  "description": "Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set on the custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "string",
          "default": "",
          "placeholder": "Finance"
        },
        {
          "displayName": "Email Address",
          "name": "email",
          "type": "string",
          "default": "",
          "placeholder": "hello@n8n.io"
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": "",
          "placeholder": "+49 30 901820"
        },
        {
          "displayName": "First Name",
          "name": "firstname",
          "type": "string",
          "default": "",
          "placeholder": "John"
        },
        {
          "displayName": "Last Name",
          "name": "lastname",
          "type": "string",
          "default": "",
          "placeholder": "Smith"
        },
        {
          "displayName": "Notes",
          "name": "note",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization Name or ID",
          "name": "organization",
          "type": "options",
          "description": "Name of the organization to assign to the user. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "loadOrganizationNames"
          }
        },
        {
          "displayName": "Phone (Landline)",
          "name": "phone",
          "type": "string",
          "default": "",
          "placeholder": "+49 30 901820"
        },
        {
          "displayName": "Phone (Mobile)",
          "name": "mobile",
          "type": "string",
          "default": "",
          "placeholder": "+49 1522 3433333"
        },
        {
          "displayName": "Verified",
          "name": "verified",
          "type": "boolean",
          "default": false,
          "description": "Whether the user has been verified"
        },
        {
          "displayName": "VIP",
          "name": "vip",
          "type": "boolean",
          "default": false,
          "description": "Whether the user is a Very Important Person"
        },
        {
          "displayName": "Website",
          "name": "web",
          "type": "string",
          "default": "",
          "placeholder": "https://n8n.io"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "user"
          ]
        }
      },
      "typeOptions": {
        "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": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Query to filter results by",
          "placeholder": "user.firstname:john"
        },
        {
          "displayName": "Sort",
          "name": "sortUi",
          "type": "fixedCollection",
          "placeholder": "Add Sort Options",
          "default": {},
          "options": [
            {
              "displayName": "Sort Options",
              "name": "sortDetails",
              "values": [
                {
                  "displayName": "Sort Key Name or ID",
                  "name": "sort_by",
                  "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": "loadUserFields"
                  },
                  "default": ""
                },
                {
                  "displayName": "Sort Order",
                  "name": "order_by",
                  "type": "options",
                  "options": [
                    {
                      "name": "Ascending",
                      "value": "asc"
                    },
                    {
                      "name": "Descending",
                      "value": "desc"
                    }
                  ],
                  "default": "asc"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

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

credentials_required:
  [
    {
      "name": "zammadBasicAuthApi",
      "required": true,
      "testedBy": "zammadBasicAuthApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "basicAuth"
          ]
        }
      }
    },
    {
      "name": "zammadTokenAuthApi",
      "required": true,
      "testedBy": "zammadTokenAuthApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "tokenAuth"
          ]
        }
      }
    }
  ]


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

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Zendesk node documentation
  description: Learn how to use the Zendesk node in n8n. Follow technical documentation to integrate Zendesk node into your workflows.
  contentType: [integration, reference]
  ---

  # Zendesk node

  Use the Zendesk node to automate work in Zendesk, and integrate Zendesk with other applications. n8n has built-in support for a wide range of Zendesk features, including creating, and deleting tickets, users, and organizations. 

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

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

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

  ## Operations

  * Ticket
      * Create a ticket
      * Delete a ticket
      * Get a ticket
      * Get all tickets
      * Recover a suspended ticket
      * Update a ticket
  * Ticket Field
      * Get a ticket field
      * Get all system and custom ticket fields
  * User
      * Create a user
      * Delete a user
      * Get a user
      * Get all users
      * Get a user's organizations
      * Get data related to the user
      * Search users
      * Update a user
  * Organization
      * Create an organization
      * Delete an organization
      * Count organizations
      * Get an organization
      * Get all organizations
      * Get data related to the organization
      * Update a organization

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "ticket",
      "options": [
        {
          "name": "Ticket",
          "value": "ticket",
          "description": "Tickets are the means through which your end users (customers) communicate with agents in Zendesk Support"
        },
        {
          "name": "Ticket Field",
          "value": "ticketField",
          "description": "Manage system and custom ticket fields"
        },
        {
          "name": "User",
          "value": "user",
          "description": "Manage users"
        },
        {
          "name": "Organization",
          "value": "organization",
          "description": "Manage organizations"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a ticket",
          "action": "Create a ticket"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a ticket",
          "action": "Delete a ticket"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a ticket",
          "action": "Get a ticket"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tickets",
          "action": "Get many tickets"
        },
        {
          "name": "Recover",
          "value": "recover",
          "description": "Recover a suspended ticket",
          "action": "Recover a ticket"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a ticket",
          "action": "Update a ticket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Description",
      "name": "description",
      "type": "string",
      "default": "",
      "description": "The first comment on the ticket",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Custom Field",
              "name": "customFieldsValues",
              "values": [
                {
                  "displayName": "Name or ID",
                  "name": "id",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "Custom field ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Custom field Value"
                }
              ]
            }
          ]
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "default": "",
          "description": "An ID you can use to link Zendesk Support tickets to local records"
        },
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          },
          "default": "",
          "description": "The group this ticket is assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Recipient",
          "name": "recipient",
          "type": "string",
          "default": "",
          "description": "The original recipient e-mail address of the ticket"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "New",
              "value": "new"
            },
            {
              "name": "On-Hold",
              "value": "hold"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Solved",
              "value": "solved"
            }
          ],
          "default": "",
          "description": "The state of the ticket"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": "",
          "description": "The value of the subject field for this ticket"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The array of tags applied to this ticket. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "options": [
            {
              "name": "Question",
              "value": "question"
            },
            {
              "name": "Incident",
              "value": "incident"
            },
            {
              "name": "Problem",
              "value": "problem"
            },
            {
              "name": "Task",
              "value": "task"
            }
          ],
          "default": "",
          "description": "The type of this ticket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFieldsJson",
      "type": "json",
      "default": "",
      "description": "Object of values to set as described <a href=\"https://developer.zendesk.com/rest_api/docs/support/tickets\">here</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Email",
          "name": "assigneeEmail",
          "type": "string",
          "default": "",
          "description": "The e-mail address of the assignee"
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Custom Field",
              "name": "customFieldsValues",
              "values": [
                {
                  "displayName": "Name or ID",
                  "name": "id",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "Custom field ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Custom field Value"
                }
              ]
            }
          ]
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "default": "",
          "description": "An ID you can use to link Zendesk Support tickets to local records"
        },
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          },
          "default": "",
          "description": "The group this ticket is assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Internal Note",
          "name": "internalNote",
          "type": "string",
          "default": "",
          "description": "Internal Ticket Note (Accepts HTML)"
        },
        {
          "displayName": "Public Reply",
          "name": "publicReply",
          "type": "string",
          "default": "",
          "description": "Public ticket reply"
        },
        {
          "displayName": "Recipient",
          "name": "recipient",
          "type": "string",
          "default": "",
          "description": "The original recipient e-mail address of the ticket"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "New",
              "value": "new"
            },
            {
              "name": "On-Hold",
              "value": "hold"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Solved",
              "value": "solved"
            }
          ],
          "default": "",
          "description": "The state of the ticket"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": "",
          "description": "The value of the subject field for this ticket"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The array of tags applied to this ticket. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "options": [
            {
              "name": "Question",
              "value": "question"
            },
            {
              "name": "Incident",
              "value": "incident"
            },
            {
              "name": "Problem",
              "value": "problem"
            },
            {
              "name": "Task",
              "value": "task"
            }
          ],
          "default": "",
          "description": "The type of this ticket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFieldsJson",
      "type": "json",
      "default": "",
      "description": "Object of values to update as described <a href=\"https://developer.zendesk.com/rest_api/docs/support/tickets\">here</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Ticket Type",
      "name": "ticketType",
      "type": "options",
      "default": "regular",
      "options": [
        {
          "name": "Regular",
          "value": "regular"
        },
        {
          "name": "Suspended",
          "value": "suspended"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get",
            "delete",
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get"
          ],
          "ticketType": [
            "regular"
          ]
        }
      }
    },
    {
      "displayName": "Suspended Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Ticket ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get"
          ],
          "ticketType": [
            "suspended"
          ]
        }
      }
    },
    {
      "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": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          },
          "displayOptions": {
            "show": {
              "/ticketType": [
                "regular"
              ]
            }
          },
          "default": "",
          "description": "The group to search. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "displayOptions": {
            "show": {
              "/ticketType": [
                "regular"
              ]
            }
          },
          "default": "",
          "description": "<a href=\"https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#syntax-examples\">Query syntax</a> to search tickets"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "options",
          "options": [
            {
              "name": "Created At",
              "value": "created_at"
            },
            {
              "name": "Priority",
              "value": "priority"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Ticket Type",
              "value": "ticket_type"
            },
            {
              "name": "Updated At",
              "value": "updated_at"
            }
          ],
          "default": "updated_at",
          "description": "Defaults to sorting by relevance"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "asc"
            },
            {
              "name": "Descending",
              "value": "desc"
            }
          ],
          "default": "asc"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "displayOptions": {
            "show": {
              "/ticketType": [
                "regular"
              ]
            }
          },
          "options": [
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "New",
              "value": "new"
            },
            {
              "name": "On-Hold",
              "value": "hold"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Solved",
              "value": "solved"
            }
          ],
          "default": "",
          "description": "The state of the ticket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "delete"
          ],
          "ticketType": [
            "regular"
          ]
        }
      }
    },
    {
      "displayName": "Suspended Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Ticket ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "delete"
          ],
          "ticketType": [
            "suspended"
          ]
        }
      }
    },
    {
      "displayName": "Suspended Ticket ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "recover"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a ticket field",
          "action": "Get a ticket field"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many system and custom ticket fields",
          "action": "Get many ticket fields"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticketField"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticket Field ID",
      "name": "ticketFieldId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticketField"
          ],
          "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": [
            "ticketField"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "ticketField"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a user",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete a user"
        },
        {
          "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"
        },
        {
          "name": "Get Organizations",
          "value": "getOrganizations",
          "description": "Get a user's organizations",
          "action": "Get a user's organizations"
        },
        {
          "name": "Get Related Data",
          "value": "getRelatedData",
          "description": "Get data related to the user",
          "action": "Get data related to a user"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search users",
          "action": "Search a user"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The user's name",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Alias",
          "name": "alias",
          "type": "string",
          "default": "",
          "description": "An alias displayed to end users"
        },
        {
          "displayName": "Custom Role ID",
          "name": "custom_role_id",
          "type": "number",
          "default": 0,
          "description": "A custom role if the user is an agent on the Enterprise plan"
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Any details you want to store about the user, such as an address"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The user's primary email address"
        },
        {
          "displayName": "External ID",
          "name": "external_id",
          "type": "string",
          "default": "",
          "description": "A unique identifier from another system"
        },
        {
          "displayName": "Locale",
          "name": "locale",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getLocales"
          },
          "default": "",
          "description": "The user's locale. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Moderator",
          "name": "moderator",
          "type": "boolean",
          "default": false,
          "description": "Whether the user has forum moderation capabilities"
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": "",
          "description": "Any notes you want to store about the user"
        },
        {
          "displayName": "Only Private Comments",
          "name": "only_private_comments",
          "type": "boolean",
          "default": false,
          "description": "Whether the user can only create private comments"
        },
        {
          "displayName": "Organization Name or ID",
          "name": "organization_id",
          "typeOptions": {
            "loadOptionsMethod": "getOrganizations"
          },
          "type": "options",
          "default": "",
          "description": "The ID of the user's organization. If the user has more than one organization memberships, the ID of the user's default organization. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The user's primary phone number"
        },
        {
          "displayName": "Report CSV",
          "name": "report_csv",
          "type": "boolean",
          "default": false,
          "description": "Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface"
        },
        {
          "displayName": "Restricted Agent",
          "name": "restricted_agent",
          "type": "boolean",
          "default": false,
          "description": "Whether the agent has any restrictions; false for admins and unrestricted agents, true for other agents"
        },
        {
          "displayName": "Role",
          "name": "role",
          "type": "options",
          "options": [
            {
              "name": "End User",
              "value": "end-user"
            },
            {
              "name": "Agent",
              "value": "agent"
            },
            {
              "name": "Admin",
              "value": "admin"
            }
          ],
          "default": "",
          "description": "The user's role"
        },
        {
          "displayName": "Signature",
          "name": "signature",
          "type": "string",
          "default": "",
          "description": "The user's signature. Only agents and admins can have signatures."
        },
        {
          "displayName": "Suspended",
          "name": "suspended",
          "type": "boolean",
          "default": false,
          "description": "Whether the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The array of tags applied to this user. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Ticket Restriction",
          "name": "ticket_restriction",
          "type": "options",
          "options": [
            {
              "name": "Organization",
              "value": "organization"
            },
            {
              "name": "Groups",
              "value": "groups"
            },
            {
              "name": "Assigned",
              "value": "assigned"
            },
            {
              "name": "Requested",
              "value": "requested"
            }
          ],
          "default": "",
          "description": "Specifies which tickets the user has access to"
        },
        {
          "displayName": "Timezone",
          "name": "time_zone",
          "type": "string",
          "default": "",
          "description": "The user's time zone"
        },
        {
          "displayName": "User Fields",
          "name": "userFieldsUi",
          "placeholder": "Add User Field",
          "description": "Values of custom fields in the user's profile",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "userFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getUserFields"
                  },
                  "default": "",
                  "description": "Name of the field to sort on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Verified",
          "name": "verified",
          "type": "boolean",
          "default": false,
          "description": "Whether the user's primary identity is verified or not"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Alias",
          "name": "alias",
          "type": "string",
          "default": "",
          "description": "An alias displayed to end users"
        },
        {
          "displayName": "Custom Role ID",
          "name": "custom_role_id",
          "type": "number",
          "default": 0,
          "description": "A custom role if the user is an agent on the Enterprise plan"
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Any details you want to store about the user, such as an address"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The user's primary email address"
        },
        {
          "displayName": "External ID",
          "name": "external_id",
          "type": "string",
          "default": "",
          "description": "A unique identifier from another system"
        },
        {
          "displayName": "Locale",
          "name": "locale",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getLocales"
          },
          "default": "",
          "description": "The user's locale. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Moderator",
          "name": "moderator",
          "type": "boolean",
          "default": false,
          "description": "Whether the user has forum moderation capabilities"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The user's name"
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": "",
          "description": "Any notes you want to store about the user"
        },
        {
          "displayName": "Only Private Comments",
          "name": "only_private_comments",
          "type": "boolean",
          "default": false,
          "description": "Whether the user can only create private comments"
        },
        {
          "displayName": "Organization Name or ID",
          "name": "organization_id",
          "typeOptions": {
            "loadOptionsMethod": "getOrganizations"
          },
          "type": "options",
          "default": "",
          "description": "The ID of the user's organization. If the user has more than one organization memberships, the ID of the user's default organization. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The user's primary phone number"
        },
        {
          "displayName": "Report CSV",
          "name": "report_csv",
          "type": "boolean",
          "default": false,
          "description": "Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface"
        },
        {
          "displayName": "Restricted Agent",
          "name": "restricted_agent",
          "type": "boolean",
          "default": false,
          "description": "Whether the agent has any restrictions; false for admins and unrestricted agents, true for other agents"
        },
        {
          "displayName": "Role",
          "name": "role",
          "type": "options",
          "options": [
            {
              "name": "End User",
              "value": "end-user"
            },
            {
              "name": "Agent",
              "value": "agent"
            },
            {
              "name": "Admin",
              "value": "admin"
            }
          ],
          "default": "",
          "description": "The user's role"
        },
        {
          "displayName": "Signature",
          "name": "signature",
          "type": "string",
          "default": "",
          "description": "The user's signature. Only agents and admins can have signatures."
        },
        {
          "displayName": "Suspended",
          "name": "suspended",
          "type": "boolean",
          "default": false,
          "description": "Whether the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "The array of tags applied to this user. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Ticket Restriction",
          "name": "ticket_restriction",
          "type": "options",
          "options": [
            {
              "name": "Organization",
              "value": "organization"
            },
            {
              "name": "Groups",
              "value": "groups"
            },
            {
              "name": "Assigned",
              "value": "assigned"
            },
            {
              "name": "Requested",
              "value": "requested"
            }
          ],
          "default": "",
          "description": "Specifies which tickets the user has access to"
        },
        {
          "displayName": "Timezone",
          "name": "time_zone",
          "type": "string",
          "default": "",
          "description": "The user's time zone"
        },
        {
          "displayName": "User Fields",
          "name": "userFieldsUi",
          "placeholder": "Add User Field",
          "description": "Values of custom fields in the user's profile",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "userFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getUserFields"
                  },
                  "default": "",
                  "description": "Name of the field to sort on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Verified",
          "name": "verified",
          "type": "boolean",
          "default": false,
          "description": "Whether the user's primary identity is verified or not"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "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": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Roles",
          "name": "role",
          "type": "multiOptions",
          "options": [
            {
              "name": "End User",
              "value": "end-user"
            },
            {
              "name": "Agent",
              "value": "agent"
            },
            {
              "name": "Admin",
              "value": "admin"
            }
          ],
          "default": []
        }
      ],
      "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": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "External ID",
          "name": "external_id",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getRelatedData"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getOrganizations"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Count",
          "value": "count",
          "description": "Count organizations",
          "action": "Count organizations"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create an organization",
          "action": "Create an organization"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an organization",
          "action": "Delete an organization"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an organization",
          "action": "Get an organization"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many organizations",
          "action": "Get many organizations"
        },
        {
          "name": "Get Related Data",
          "value": "getRelatedData",
          "description": "Get data related to the organization",
          "action": "Get data related to an organization"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a organization",
          "action": "Update an organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Details about the organization, such as the address"
        },
        {
          "displayName": "Domain Names",
          "name": "domain_names",
          "type": "string",
          "default": "",
          "description": "Comma-separated domain names associated with this organization"
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization Fields",
          "name": "organizationFieldsUi",
          "placeholder": "Add Organization Field",
          "description": "Values of custom fields in the organization's profile",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "organizationFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "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": "getOrganizationFields"
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "IDs of tags applied to this organization. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Details about the organization, such as the address"
        },
        {
          "displayName": "Domain Names",
          "name": "domain_names",
          "type": "string",
          "default": "",
          "description": "Comma-separated domain names associated with this organization"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization Fields",
          "name": "organizationFieldsUi",
          "placeholder": "Add Organization Field",
          "description": "Values of custom fields in the organization's profile",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "organizationFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "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": "getOrganizationFields"
                  },
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "IDs of tags applied to this organization. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "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": [
            "organization"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "getRelatedData"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a ticket"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a ticket"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a ticket"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many tickets"
    },
    {
      "operation": "recover",
      "name": "Recover",
      "description": "Recover a suspended ticket"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a ticket"
    }
  ]

credentials_required:
  [
    {
      "name": "zendeskApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiToken"
          ]
        }
      }
    },
    {
      "name": "zendeskOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


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

updated_at: 2025-08-26 06:29:25
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Zendesk Trigger node documentation
  description: Learn how to use the Zendesk Trigger node in n8n. Follow technical documentation to integrate Zendesk Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Zendesk Trigger node

  [Zendesk](https://www.zendesk.com/){:target=_blank .external-link} is a support ticketing system, designed to help track, prioritize, and solve customer support interactions. More than just a help desk, Zendesk Support helps nurture customer relationships with personalized, responsive support across any channel.

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Service",
      "name": "service",
      "type": "options",
      "default": "support",
      "options": [
        {
          "name": "Support",
          "value": "support"
        }
      ],
      "required": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Field Names or IDs",
          "name": "fields",
          "description": "The fields to return the values of. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "multiOptions",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getFields"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "service": [
            "support"
          ]
        }
      }
    },
    {
      "displayName": "Conditions",
      "name": "conditions",
      "type": "fixedCollection",
      "default": {},
      "description": "The condition to set",
      "options": [
        {
          "name": "all",
          "displayName": "All",
          "values": [
            {
              "displayName": "Resource",
              "name": "resource",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Ticket",
                  "value": "ticket"
                }
              ],
              "default": "ticket"
            },
            {
              "displayName": "Field",
              "name": "field",
              "type": "options",
              "displayOptions": {
                "show": {
                  "resource": [
                    "ticket"
                  ]
                }
              },
              "options": [
                {
                  "name": "Assignee",
                  "value": "assignee"
                },
                {
                  "name": "Group",
                  "value": "group"
                },
                {
                  "name": "Priority",
                  "value": "priority"
                },
                {
                  "name": "Status",
                  "value": "status"
                },
                {
                  "name": "Type",
                  "value": "type"
                }
              ],
              "default": "status"
            },
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "options": [
                {
                  "name": "Changed",
                  "value": "changed"
                },
                {
                  "name": "Changed From",
                  "value": "value_previous"
                },
                {
                  "name": "Changed To",
                  "value": "value"
                },
                {
                  "name": "Greater Than",
                  "value": "greater_than"
                },
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "Less Than",
                  "value": "less_than"
                },
                {
                  "name": "Not Changed",
                  "value": "not_changed"
                },
                {
                  "name": "Not Changed From",
                  "value": "not_value_previous"
                },
                {
                  "name": "Not Changed To",
                  "value": "not_value"
                }
              ],
              "displayOptions": {
                "hide": {
                  "field": [
                    "assignee"
                  ]
                }
              },
              "default": "is"
            },
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "options": [
                {
                  "name": "Changed",
                  "value": "changed"
                },
                {
                  "name": "Changed From",
                  "value": "value_previous"
                },
                {
                  "name": "Changed To",
                  "value": "value"
                },
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "Not Changed",
                  "value": "not_changed"
                },
                {
                  "name": "Not Changed From",
                  "value": "not_value_previous"
                },
                {
                  "name": "Not Changed To",
                  "value": "not_value"
                }
              ],
              "displayOptions": {
                "show": {
                  "field": [
                    "assignee"
                  ]
                }
              },
              "default": "is"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "displayOptions": {
                "show": {
                  "field": [
                    "status"
                  ]
                },
                "hide": {
                  "operation": [
                    "changed",
                    "not_changed"
                  ],
                  "field": [
                    "assignee",
                    "group",
                    "priority",
                    "type"
                  ]
                }
              },
              "options": [
                {
                  "name": "Closed",
                  "value": "closed"
                },
                {
                  "name": "New",
                  "value": "new"
                },
                {
                  "name": "Open",
                  "value": "open"
                },
                {
                  "name": "Pending",
                  "value": "pending"
                },
                {
                  "name": "Solved",
                  "value": "solved"
                }
              ],
              "default": "open"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "displayOptions": {
                "show": {
                  "field": [
                    "type"
                  ]
                },
                "hide": {
                  "operation": [
                    "changed",
                    "not_changed"
                  ],
                  "field": [
                    "assignee",
                    "group",
                    "priority",
                    "status"
                  ]
                }
              },
              "options": [
                {
                  "name": "Question",
                  "value": "question"
                },
                {
                  "name": "Incident",
                  "value": "incident"
                },
                {
                  "name": "Problem",
                  "value": "problem"
                },
                {
                  "name": "Task",
                  "value": "task"
                }
              ],
              "default": "question"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "displayOptions": {
                "show": {
                  "field": [
                    "priority"
                  ]
                },
                "hide": {
                  "operation": [
                    "changed",
                    "not_changed"
                  ],
                  "field": [
                    "assignee",
                    "group",
                    "type",
                    "status"
                  ]
                }
              },
              "options": [
                {
                  "name": "Low",
                  "value": "low"
                },
                {
                  "name": "Normal",
                  "value": "normal"
                },
                {
                  "name": "High",
                  "value": "high"
                },
                {
                  "name": "Urgent",
                  "value": "urgent"
                }
              ],
              "default": "low"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getGroups"
              },
              "displayOptions": {
                "show": {
                  "field": [
                    "group"
                  ]
                },
                "hide": {
                  "field": [
                    "assignee",
                    "priority",
                    "type",
                    "status"
                  ]
                }
              },
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getUsers"
              },
              "displayOptions": {
                "show": {
                  "field": [
                    "assignee"
                  ]
                },
                "hide": {
                  "field": [
                    "group",
                    "priority",
                    "type",
                    "status"
                  ]
                }
              },
              "default": ""
            }
          ]
        },
        {
          "name": "any",
          "displayName": "Any",
          "values": [
            {
              "displayName": "Resource",
              "name": "resource",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Ticket",
                  "value": "ticket"
                }
              ],
              "default": "ticket"
            },
            {
              "displayName": "Field",
              "name": "field",
              "type": "options",
              "displayOptions": {
                "show": {
                  "resource": [
                    "ticket"
                  ]
                }
              },
              "options": [
                {
                  "name": "Assignee",
                  "value": "assignee"
                },
                {
                  "name": "Group",
                  "value": "group"
                },
                {
                  "name": "Priority",
                  "value": "priority"
                },
                {
                  "name": "Status",
                  "value": "status"
                },
                {
                  "name": "Type",
                  "value": "type"
                }
              ],
              "default": "status"
            },
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "options": [
                {
                  "name": "Changed",
                  "value": "changed"
                },
                {
                  "name": "Changed From",
                  "value": "value_previous"
                },
                {
                  "name": "Changed To",
                  "value": "value"
                },
                {
                  "name": "Greater Than",
                  "value": "greater_than"
                },
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "Less Than",
                  "value": "less_than"
                },
                {
                  "name": "Not Changed",
                  "value": "not_changed"
                },
                {
                  "name": "Not Changed From",
                  "value": "not_value_previous"
                },
                {
                  "name": "Not Changed To",
                  "value": "not_value"
                }
              ],
              "displayOptions": {
                "hide": {
                  "field": [
                    "assignee"
                  ]
                }
              },
              "default": "is"
            },
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "options": [
                {
                  "name": "Changed",
                  "value": "changed"
                },
                {
                  "name": "Changed From",
                  "value": "value_previous"
                },
                {
                  "name": "Changed To",
                  "value": "value"
                },
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "Not Changed",
                  "value": "not_changed"
                },
                {
                  "name": "Not Changed From",
                  "value": "not_value_previous"
                },
                {
                  "name": "Not Changed To",
                  "value": "not_value"
                }
              ],
              "displayOptions": {
                "show": {
                  "field": [
                    "assignee"
                  ]
                }
              },
              "default": "is"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "displayOptions": {
                "show": {
                  "field": [
                    "status"
                  ]
                },
                "hide": {
                  "operation": [
                    "changed",
                    "not_changed"
                  ],
                  "field": [
                    "assignee",
                    "group",
                    "priority",
                    "type"
                  ]
                }
              },
              "options": [
                {
                  "name": "Closed",
                  "value": "closed"
                },
                {
                  "name": "New",
                  "value": "new"
                },
                {
                  "name": "Open",
                  "value": "open"
                },
                {
                  "name": "Pending",
                  "value": "pending"
                },
                {
                  "name": "Solved",
                  "value": "solved"
                }
              ],
              "default": "open"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "displayOptions": {
                "show": {
                  "field": [
                    "type"
                  ]
                },
                "hide": {
                  "operation": [
                    "changed",
                    "not_changed"
                  ],
                  "field": [
                    "assignee",
                    "group",
                    "priority",
                    "status"
                  ]
                }
              },
              "options": [
                {
                  "name": "Question",
                  "value": "question"
                },
                {
                  "name": "Incident",
                  "value": "incident"
                },
                {
                  "name": "Problem",
                  "value": "problem"
                },
                {
                  "name": "Task",
                  "value": "task"
                }
              ],
              "default": "question"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "displayOptions": {
                "show": {
                  "field": [
                    "priority"
                  ]
                },
                "hide": {
                  "operation": [
                    "changed",
                    "not_changed"
                  ],
                  "field": [
                    "assignee",
                    "group",
                    "type",
                    "status"
                  ]
                }
              },
              "options": [
                {
                  "name": "Low",
                  "value": "low"
                },
                {
                  "name": "Normal",
                  "value": "normal"
                },
                {
                  "name": "High",
                  "value": "high"
                },
                {
                  "name": "Urgent",
                  "value": "urgent"
                }
              ],
              "default": "low"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getGroups"
              },
              "displayOptions": {
                "show": {
                  "field": [
                    "group"
                  ]
                },
                "hide": {
                  "field": [
                    "assignee",
                    "priority",
                    "type",
                    "status"
                  ]
                }
              },
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getUsers"
              },
              "displayOptions": {
                "show": {
                  "field": [
                    "assignee"
                  ]
                },
                "hide": {
                  "field": [
                    "group",
                    "priority",
                    "type",
                    "status"
                  ]
                }
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "service": [
            "support"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

credentials_required:
  [
    {
      "name": "zendeskApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiToken"
          ]
        }
      }
    },
    {
      "name": "zendeskOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


