# nodes

node_type: helpScout
package_name: n8n-nodes-base
display_name: HelpScout
description: Consume HelpScout API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"helpScoutOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Help Scout node documentation
  description: Learn how to use the Help Scout node in n8n. Follow technical documentation to integrate Help Scout node into your workflows.
  contentType: [integration, reference]
  ---

  # Help Scout node

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

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

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

  ## Operations

  * Conversation
      * Create a new conversation
      * Delete a conversation
      * Get a conversation
      * Get all conversations
  * Customer
      * Create a new customer
      * Get a customer
      * Get all customers
      * Get customer property definitions
      * Update a customer
  * Mailbox
      * Get data of a mailbox
      * Get all mailboxes
  * Thread
      * Create a new chat thread
      * Get all chat threads

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Conversation","value":"conversation"},{"name":"Customer","value":"customer"},{"name":"Mailbox","value":"mailbox"},{"name":"Thread","value":"thread"}],"default":"conversation"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["conversation"]}},"options":[{"name":"Create","value":"create","description":"Create a new conversation","action":"Create a conversation"},{"name":"Delete","value":"delete","description":"Delete a conversation","action":"Delete a conversation"},{"name":"Get","value":"get","description":"Get a conversation","action":"Get a conversation"},{"name":"Get Many","value":"getAll","description":"Get many conversations","action":"Get many conversations"}],"default":"create"},{"displayName":"Mailbox Name or ID","name":"mailboxId","type":"options","typeOptions":{"loadOptionsMethod":"getMailboxes"},"required":true,"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"default":"","description":"ID of a mailbox where the conversation is being created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Status","name":"status","type":"options","required":true,"options":[{"name":"Active","value":"active"},{"name":"Closed","value":"closed"},{"name":"Pending","value":"pending"}],"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"default":"","description":"Conversation status"},{"displayName":"Subject","name":"subject","type":"string","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"default":"","description":"Conversation’s subject"},{"displayName":"Type","name":"type","required":true,"type":"options","options":[{"name":"Chat","value":"chat"},{"name":"Email","value":"email"},{"name":"Phone","value":"phone"}],"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"default":"","description":"Conversation type"},{"displayName":"Resolve Data","name":"resolveData","type":"boolean","default":true,"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"description":"By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"options":[{"displayName":"Assign To","name":"assignTo","type":"number","default":0,"description":"The Help Scout user assigned to the conversation"},{"displayName":"Auto Reply","name":"autoReply","type":"boolean","default":false,"description":"Whether set to true, an auto reply will be sent as long as there is at least one customer thread in the conversation"},{"displayName":"Closed At","name":"closedAt","type":"dateTime","default":"","description":"When the conversation was closed, only applicable for imported conversations"},{"displayName":"Created At","name":"createdAt","type":"dateTime","default":"","description":"When this conversation was created - ISO 8601 date time"},{"displayName":"Customer Email","name":"customerEmail","type":"string","default":""},{"displayName":"Customer ID","name":"customerId","type":"number","default":0},{"displayName":"Imported","name":"imported","type":"boolean","default":false,"description":"Whether set to true, no outgoing emails or notifications will be generated"},{"displayName":"Tag Names or IDs","name":"tags","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTags"},"default":[],"description":"List of tags to be added to the conversation. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"User ID","name":"user","type":"number","default":0,"description":"ID of the user who is adding the conversation and threads"}]},{"displayName":"Threads","name":"threadsUi","placeholder":"Add Thread","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["conversation"]}},"default":{},"options":[{"displayName":"Thread","name":"threadsValues","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"Chat","value":"chat"},{"name":"Customer","value":"customer"},{"name":"Note","value":"note"},{"name":"Phone","value":"phone"},{"name":"Reply","value":"reply"}],"default":""},{"displayName":"Text","name":"text","type":"string","default":"","description":"The message text"},{"displayName":"Bcc","name":"bcc","displayOptions":{"show":{"type":["customer"]}},"type":"string","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Email"},"default":[],"description":"Email addresses"},{"displayName":"Cc","name":"cc","displayOptions":{"show":{"type":["customer"]}},"type":"string","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Email"},"default":[],"description":"Email addresses"},{"displayName":"Draft","name":"draft","displayOptions":{"show":{"type":["reply"]}},"type":"boolean","default":false,"description":"Whether true, a draft reply is created"}]}]},{"displayName":"Conversation ID","name":"conversationId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["conversation"],"operation":["get"]}}},{"displayName":"Conversation ID","name":"conversationId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["conversation"],"operation":["delete"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["conversation"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["conversation"],"returnAll":[false]}},"typeOptions":{"minValue":1},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["conversation"],"operation":["getAll"]}},"options":[{"displayName":"Assign To","name":"assignTo","type":"number","default":0,"description":"Filters conversations by assignee ID"},{"displayName":"Embed","name":"embed","type":"options","options":[{"name":"Threads","value":"threads"}],"default":"","description":"Allows embedding/loading of sub-entities"},{"displayName":"Folder ID","name":"folder","type":"string","default":"","description":"Filters conversations from a specific folder ID"},{"displayName":"Mailbox ID","name":"mailbox","type":"string","default":"","description":"Filters conversations from a specific mailbox"},{"displayName":"Modified Since","name":"modifiedSince","type":"dateTime","default":"","description":"Returns only conversations that were modified after this date"},{"displayName":"Number","name":"number","type":"number","default":0,"typeOptions":{"minValue":0},"description":"Looks up conversation by conversation number"},{"displayName":"Query","name":"query","type":"string","default":"","description":"Advanced search <a href=\"https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/#query\">Examples</a>"},{"displayName":"Sort Field","name":"sortField","type":"options","options":[{"name":"Created At","value":"createdAt"},{"name":"Customer Email","value":"customerEmail"},{"name":"Customer Name","value":"customerName"},{"name":"Mailbox ID","value":"mailboxid"},{"name":"Modified At","value":"modifiedAt"},{"name":"Number","value":"number"},{"name":"Score","value":"score"},{"name":"Status","value":"status"},{"name":"Subject","value":"subject"}],"default":"","description":"Sorts the result by specified field"},{"displayName":"Sort Order","name":"sortOrder","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"desc"},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Active","value":"active"},{"name":"All","value":"all"},{"name":"Closed","value":"closed"},{"name":"Open","value":"open"},{"name":"Pending","value":"pending"},{"name":"Spam","value":"spam"}],"default":"active","description":"Filter conversation by status"},{"displayName":"Tag Names or IDs","name":"tags","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTags"},"default":[],"description":"Filter conversation by tags. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["customer"]}},"options":[{"name":"Create","value":"create","description":"Create a new customer","action":"Create a customer"},{"name":"Get","value":"get","description":"Get a customer","action":"Get a customer"},{"name":"Get Many","value":"getAll","description":"Get many customers","action":"Get many customers"},{"name":"Properties","value":"properties","description":"Get customer property definitions","action":"Get customer properties"},{"name":"Update","value":"update","description":"Update a customer","action":"Update a customer"}],"default":"create"},{"displayName":"Resolve Data","name":"resolveData","type":"boolean","default":true,"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"description":"By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"options":[{"displayName":"Age","name":"age","type":"number","typeOptions":{"minValue":1},"default":1,"description":"Customer’s age"},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the customer. When defined it must be between 1 and 40 characters."},{"displayName":"Gender","name":"gender","type":"options","options":[{"name":"Female","value":"female"},{"name":"Male","value":"male"},{"name":"Unknown","value":"unknown"}],"default":"","description":"Gender of this customer"},{"displayName":"Job Title","name":"jobTitle","type":"string","default":"","description":"Job title. Max length 60 characters."},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Last name of the customer"},{"displayName":"Location","name":"location","type":"string","default":"","description":"Location of the customer"},{"displayName":"Notes","name":"background","type":"string","default":""},{"displayName":"Organization","name":"organization","type":"string","default":""},{"displayName":"Photo Url","name":"photoUrl","type":"string","default":"","description":"URL of the customer’s photo"}]},{"displayName":"Address","name":"addressUi","placeholder":"Add Address","type":"fixedCollection","displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"default":{},"options":[{"displayName":"Address","name":"addressValue","values":[{"displayName":"Line 1","name":"line1","type":"string","default":""},{"displayName":"Line 2","name":"line2","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Country Name or ID","name":"country","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCountriesCodes"},"default":""},{"displayName":"Postal Code","name":"postalCode","type":"string","default":""}]}]},{"displayName":"Chat Handles","name":"chatsUi","placeholder":"Add Chat Handle","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"default":{},"options":[{"displayName":"Chat Handle","name":"chatsValues","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"AIM","value":"aim"},{"name":"Google Talk","value":"gtalk"},{"name":"ICQ","value":"icq"},{"name":"MSN","value":"msn"},{"name":"Other","value":"other"},{"name":"QQ","value":"qq"},{"name":"Skype","value":"skype"},{"name":"XMPP","value":"xmpp"},{"name":"Yahoo","value":"yahoo"}],"description":"Chat type","default":""},{"displayName":"Value","name":"value","type":"string","default":"","description":"Chat handle"}]}]},{"displayName":"Emails","name":"emailsUi","placeholder":"Add Email","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"default":{},"options":[{"displayName":"Email","name":"emailsValues","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"Home","value":"home"},{"name":"Other","value":"other"},{"name":"Work","value":"work"}],"description":"Location for this email address","default":""},{"displayName":"Value","name":"value","type":"string","default":"","description":"Email"}]}]},{"displayName":"Phones","name":"phonesUi","placeholder":"Add Phone","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"default":{},"options":[{"displayName":"Email","name":"phonesValues","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"Fax","value":"fax"},{"name":"Home","value":"home"},{"name":"Other","value":"other"},{"name":"Pager","value":"pager"},{"name":"Work","value":"work"}],"description":"Location for this phone","default":""},{"displayName":"Value","name":"value","type":"string","default":"","description":"Phone"}]}]},{"displayName":"Social Profiles","name":"socialProfilesUi","placeholder":"Add Social Profile","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"default":{},"options":[{"displayName":"Social Profile","name":"socialProfilesValues","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"About Me","value":"aboutMe"},{"name":"Facebook","value":"facebook"},{"name":"Flickr","value":"flickr"},{"name":"Forsquare","value":"forsquare"},{"name":"Google","value":"google"},{"name":"Google Plus","value":"googleplus"},{"name":"Linkedin","value":"linkedin"},{"name":"Other","value":"other"},{"name":"Quora","value":"quora"},{"name":"Tungleme","value":"tungleme"},{"name":"Twitter","value":"twitter"},{"name":"Youtube","value":"youtube"}],"description":"Type of social profile","default":""},{"displayName":"Value","name":"value","type":"string","default":"","description":"Social Profile handle (URL for example)"}]}]},{"displayName":"Websites","name":"websitesUi","placeholder":"Add Website","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["customer"]}},"default":{},"options":[{"displayName":"Website","name":"websitesValues","values":[{"displayName":"Value","name":"value","type":"string","default":"","description":"Website URL"}]}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["customer"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["customer"],"returnAll":[false]}},"typeOptions":{"minValue":1},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["customer"],"operation":["getAll"]}},"options":[{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"Filters customers by first name"},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Filters customers by last name"},{"displayName":"Mailbox ID","name":"mailbox","type":"string","default":"","description":"Filters customers from a specific mailbox"},{"displayName":"Modified Since","name":"modifiedSince","type":"dateTime","default":"","description":"Returns only customers that were modified after this date"},{"displayName":"Sort Field","name":"sortField","type":"options","options":[{"name":"Score","value":"score"},{"name":"First Name","value":"firstName"},{"name":"Last Name","value":"lastName"},{"name":"Modified At","value":"modifiedAt"}],"default":"score","description":"Sorts the result by specified field"},{"displayName":"Sort Order","name":"sortOrder","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"desc"},{"displayName":"Query","name":"query","type":"string","default":"","description":"Advanced search <a href=\"https://developer.helpscout.com/mailbox-api/endpoints/customers/list/#query\">Examples</a>"}]},{"displayName":"Customer ID","name":"customerId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["customer"],"operation":["get"]}}},{"displayName":"Customer ID","name":"customerId","type":"string","default":"","displayOptions":{"show":{"operation":["update"],"resource":["customer"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["update"],"resource":["customer"]}},"options":[{"displayName":"Age","name":"age","type":"number","typeOptions":{"minValue":1},"default":1,"description":"Customer’s age"},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the customer. When defined it must be between 1 and 40 characters."},{"displayName":"Gender","name":"gender","type":"options","options":[{"name":"Female","value":"female"},{"name":"Male","value":"male"},{"name":"Unknown","value":"unknown"}],"default":"","description":"Gender of this customer"},{"displayName":"Job Title","name":"jobTitle","type":"string","default":"","description":"Job title. Max length 60 characters."},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Last name of the customer"},{"displayName":"Location","name":"location","type":"string","default":"","description":"Location of the customer"},{"displayName":"Notes","name":"background","type":"string","default":""},{"displayName":"Organization","name":"organization","type":"string","default":""},{"displayName":"Photo Url","name":"photoUrl","type":"string","default":"","description":"URL of the customer’s photo"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["mailbox"]}},"options":[{"name":"Get","value":"get","description":"Get data of a mailbox","action":"Get a mailbox"},{"name":"Get Many","value":"getAll","description":"Get many mailboxes","action":"Get many mailboxes"}],"default":"get"},{"displayName":"Mailbox ID","name":"mailboxId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["mailbox"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["mailbox"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["mailbox"],"returnAll":[false]}},"typeOptions":{"minValue":1},"default":50,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["thread"]}},"options":[{"name":"Create","value":"create","description":"Create a new chat thread","action":"Create a thread"},{"name":"Get Many","value":"getAll","description":"Get many chat threads","action":"Get many threads"}],"default":"create"},{"displayName":"Conversation ID","name":"conversationId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["thread"],"operation":["create"]}}},{"displayName":"Type","name":"type","type":"options","required":true,"displayOptions":{"show":{"resource":["thread"],"operation":["create"]}},"options":[{"name":"Chat","value":"chat"},{"name":"Customer","value":"customer"},{"name":"Note","value":"note"},{"name":"Phone","value":"phone"},{"name":"Reply","value":"reply"}],"default":""},{"displayName":"Text","name":"text","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["thread"],"operation":["create"]}},"description":"The chat text"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["thread"]}},"options":[{"displayName":"Created At","name":"createdAt","type":"dateTime","default":""},{"displayName":"Customer Email","name":"customerEmail","type":"string","default":""},{"displayName":"Customer ID","name":"customerId","type":"number","default":0},{"displayName":"Draft","name":"draft","type":"boolean","default":false,"displayOptions":{"show":{"/type":["note"]}},"description":"Whether a draft reply is created"},{"displayName":"Imported","name":"imported","type":"boolean","default":false,"description":"Whether no outgoing emails or notifications will be generated"}]},{"displayName":"Attachments","name":"attachmentsUi","placeholder":"Add Attachments","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["create"],"resource":["thread"]}},"options":[{"name":"attachmentsValues","displayName":"Attachments Values","values":[{"displayName":"FileName","name":"fileName","type":"string","default":"","description":"Attachment’s file name"},{"displayName":"Mime Type","name":"mimeType","type":"string","default":"","description":"Attachment’s mime type"},{"displayName":"Data","name":"data","type":"string","default":"","placeholder":"ZXhhbXBsZSBmaWxl","description":"Base64-encoded stream of data"}]},{"name":"attachmentsBinary","displayName":"Attachments Binary","values":[{"displayName":"Property","name":"property","type":"string","default":"data","description":"Name of the binary properties which contain data which should be added to email as attachment"}]}],"default":{},"description":"Array of supported attachments to add to the message"},{"displayName":"Conversation ID","name":"conversationId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["thread"],"operation":["getAll"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["thread"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["thread"],"returnAll":[false]}},"typeOptions":{"minValue":1},"default":50,"description":"Max number of results to return"}]

operations:
  [{"type":"resource","resource":"conversation","name":"Conversation"},{"type":"resource","resource":"customer","name":"Customer"},{"type":"resource","resource":"mailbox","name":"Mailbox"},{"type":"resource","resource":"thread","name":"Thread"},{"type":"operation","operation":"create","name":"Create","action":"Create a conversation","resources":["conversation"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a conversation","resources":["conversation"]},{"type":"operation","operation":"get","name":"Get","action":"Get a conversation","resources":["conversation"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many conversations","resources":["conversation"]},{"type":"operation","operation":"create","name":"Create","action":"Create a customer","resources":["customer"]},{"type":"operation","operation":"get","name":"Get","action":"Get a customer","resources":["customer"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many customers","resources":["customer"]},{"type":"operation","operation":"properties","name":"Properties","action":"Get customer properties","resources":["customer"]},{"type":"operation","operation":"update","name":"Update","action":"Update a customer","resources":["customer"]},{"type":"operation","operation":"get","name":"Get","action":"Get a mailbox","resources":["mailbox"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many mailboxes","resources":["mailbox"]},{"type":"operation","operation":"create","name":"Create","action":"Create a thread","resources":["thread"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many threads","resources":["thread"]}]


node_type: helpScoutTrigger
package_name: n8n-nodes-base
display_name: HelpScout Trigger
description: Starts the workflow when HelpScout events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"helpScoutOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Help Scout Trigger node documentation
  description: Learn how to use the Help Scout Trigger node in n8n. Follow technical documentation to integrate Help Scout Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Help Scout Trigger node

  [Help Scout](https://www.helpscout.com/){:target=_blank .external-link} is a help desk software that provides an email-based customer support platform, knowledge base tool, and an embeddable search/contact widget for customer service professionals.

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

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

properties_schema:
  [{"displayName":"Events","name":"events","type":"multiOptions","options":[{"name":"Conversation - Assigned","value":"convo.assigned"},{"name":"Conversation - Created","value":"convo.created"},{"name":"Conversation - Deleted","value":"convo.deleted"},{"name":"Conversation - Merged","value":"convo.merged"},{"name":"Conversation - Moved","value":"convo.moved"},{"name":"Conversation - Status","value":"convo.status"},{"name":"Conversation - Tags","value":"convo.tags"},{"name":"Conversation Agent Reply - Created","value":"convo.agent.reply.created"},{"name":"Conversation Customer Reply - Created","value":"convo.customer.reply.created"},{"name":"Conversation Note - Created","value":"convo.note.created"},{"name":"Customer - Created","value":"customer.created"},{"name":"Rating - Received","value":"satisfaction.ratings"}],"default":[],"required":true}]


node_type: highLevel
package_name: n8n-nodes-base
display_name: HighLevel
description: Consume HighLevel API
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"highLevelApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HighLevel node documentation
  description: Learn how to use the HighLevel node in n8n. Follow technical documentation to integrate HighLevel node into your workflows.
  contentType: [integration, reference]
  ---

  # HighLevel node

  Use the HighLevel node to automate work in HighLevel, and integrate HighLevel with other applications. n8n has built-in support for a wide range of HighLevel features, including creating, updating, deleting, and getting contacts, opportunities, and tasks, as well as booking appointments and getting free time slots in calendars. 

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

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

  ## Operations

  * Contact
  	* Create or update
  	* Delete
  	* Get
  	* Get many
  	* Update
  * Opportunity
  	* Create
  	* Delete
  	* Get
  	* Get many
  	* Update
  * Task
  	* Create
  	* Delete
  	* Get
  	* Get many
  	* Update
  * Calendar
  	* Book an appointment
  	* Get free slots

  ## Templates and examples

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

  ## Related resources

  Refer to [HighLevel's API documentation and support forums](https://help.gohighlevel.com/support/solutions/articles/48001060529-highlevel-api){: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","noDataExpression":true,"options":[{"name":"Contact","value":"contact"},{"name":"Opportunity","value":"opportunity"},{"name":"Task","value":"task"}],"default":"contact","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"options":[{"name":"Create or Update","value":"create","routing":{"request":{"method":"POST","url":"/contacts"},"send":{"preSend":[null,null]},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"contact"}}]}},"action":"Create or update a contact"},{"name":"Delete","value":"delete","routing":{"request":{"method":"DELETE","url":"=/contacts/{{$parameter.contactId}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"action":"Delete a contact"},{"name":"Get","value":"get","routing":{"request":{"method":"GET","url":"=/contacts/{{$parameter.contactId}}"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"contact"}}]}},"action":"Get a contact"},{"name":"Get Many","value":"getAll","routing":{"request":{"method":"GET","url":"=/contacts"},"send":{"paginate":true}},"action":"Get many contacts"},{"name":"Lookup","value":"lookup","routing":{"request":{"method":"GET","url":"=/contacts/lookup?email={{$parameter.email}}&phone={{$parameter.phone}}"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"contacts"}}]}},"action":"Lookup a contact"},{"name":"Update","value":"update","routing":{"request":{"method":"PUT","url":"=/contacts/{{$parameter.contactId}}"},"send":{"preSend":[null,null]},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"contact"}}]}},"action":"Update a contact"}],"default":"create"},{"displayName":"Create a new contact or update an existing one if email or phone matches (upsert)","name":"contactCreateNotice","type":"notice","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"default":""},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","description":"Email or Phone are required to create contact","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"default":"","routing":{"send":{"type":"body","property":"email"}}},{"displayName":"Phone","name":"phone","type":"string","description":"Phone or Email are required to create contact. Phone number has to start with a valid <a href=\"https://en.wikipedia.org/wiki/List_of_country_calling_codes\">country code</a> leading with + sign.","placeholder":"+491234567890","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"default":"","routing":{"send":{"type":"body","property":"phone"}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"options":[{"displayName":"Address","name":"address1","type":"string","default":"","routing":{"send":{"type":"body","property":"address1"}}},{"displayName":"City","name":"city","type":"string","default":"","routing":{"send":{"type":"body","property":"city"}}},{"displayName":"Custom Fields","name":"customFields","placeholder":"Add Field","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"options":[{"name":"values","displayName":"Value","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","required":true,"default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptions":{"routing":{"request":{"url":"/custom-fields","method":"GET"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"customFields"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}}},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=customField.{{$parent.fieldId}}","type":"body"}}}]}]},{"displayName":"Do Not Disturb","name":"dnd","description":"Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.","type":"boolean","default":false,"routing":{"send":{"type":"body","property":"dnd"}}},{"displayName":"First Name","name":"firstName","type":"string","default":"","routing":{"send":{"type":"body","property":"firstName"}}},{"displayName":"Last Name","name":"lastName","type":"string","default":"","routing":{"send":{"type":"body","property":"lastName"}}},{"displayName":"Name","name":"name","type":"string","default":"e.g. John Deo","description":"The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set","routing":{"send":{"type":"body","property":"name"}}},{"displayName":"Postal Code","name":"postalCode","type":"string","default":"","routing":{"send":{"type":"body","property":"postalCode"}}},{"displayName":"Source","name":"source","type":"string","default":"","placeholder":"e.g. Public API","routing":{"send":{"type":"body","property":"source"}}},{"displayName":"State","name":"state","type":"string","default":"","routing":{"send":{"type":"body","property":"state"}}},{"displayName":"Tags","name":"tags","type":"string","hint":"Comma separated list of tags, array of strings can be set in expression","default":"","routing":{"send":{"type":"body","property":"tags"}}},{"displayName":"Timezone","name":"timezone","type":"options","default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTimezones"},"routing":{"send":{"type":"body","property":"timezone"}}},{"displayName":"Website","name":"website","type":"string","default":"","routing":{"send":{"type":"body","property":"website"}}}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"default":""},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"options":[{"displayName":"Address","name":"address1","type":"string","default":"","routing":{"send":{"type":"body","property":"address1"}}},{"displayName":"City","name":"city","type":"string","default":"","routing":{"send":{"type":"body","property":"city"}}},{"displayName":"Custom Fields","name":"customFields","placeholder":"Add Field","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"options":[{"name":"values","displayName":"Value","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","required":true,"default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptions":{"routing":{"request":{"url":"/custom-fields","method":"GET"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"customFields"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}}},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=customField.{{$parent.fieldId}}","type":"body"}}}]}]},{"displayName":"Do Not Disturb","name":"dnd","description":"Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.","type":"boolean","default":false,"routing":{"send":{"type":"body","property":"dnd"}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","routing":{"send":{"type":"body","property":"email"}}},{"displayName":"First Name","name":"firstName","type":"string","default":"","routing":{"send":{"type":"body","property":"firstName"}}},{"displayName":"Last Name","name":"lastName","type":"string","default":"","routing":{"send":{"type":"body","property":"lastName"}}},{"displayName":"Name","name":"name","type":"string","description":"The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set","default":"e.g. John Deo","routing":{"send":{"type":"body","property":"name"}}},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number has to start with a valid <a href=\"https://en.wikipedia.org/wiki/List_of_country_calling_codes\">country code</a> leading with + sign","placeholder":"+491234567890","routing":{"send":{"type":"body","property":"phone"}}},{"displayName":"Postal Code","name":"postalCode","type":"string","default":"","routing":{"send":{"type":"body","property":"postalCode"}}},{"displayName":"State","name":"state","type":"string","default":"","routing":{"send":{"type":"body","property":"state"}}},{"displayName":"Tags","name":"tags","type":"string","hint":"Comma separated list of tags, array of strings can be set in expression","default":"","routing":{"send":{"type":"body","property":"tags"}}},{"displayName":"Timezone","name":"timezone","type":"options","default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTimezones"},"routing":{"send":{"type":"body","property":"timezone"}}},{"displayName":"Website","name":"website","type":"string","default":"","routing":{"send":{"type":"body","property":"website"}}}]},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"resource":["contact"],"operation":["delete"]}},"default":""},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"resource":["contact"],"operation":["get"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":20,"routing":{"send":{"type":"query","property":"limit"},"output":{"maxResults":"={{$value}}"}},"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"options":[{"displayName":"Query","name":"query","type":"string","default":"","description":"Query will search on these fields: Name, Phone, Email, Tags, and Company Name","routing":{"send":{"type":"query","property":"query"}}}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"options":[{"displayName":"Order","name":"order","type":"options","options":[{"name":"Descending","value":"desc"},{"name":"Ascending","value":"asc"}],"default":"desc","routing":{"send":{"type":"query","property":"order"}}},{"displayName":"Sort By","name":"sortBy","type":"options","options":[{"name":"Date Added","value":"date_added"},{"name":"Date Updated","value":"date_updated"}],"default":"date_added","routing":{"send":{"type":"query","property":"sortBy"}}}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","description":"Lookup Contact by Email. If Email is not found it will try to find a contact by phone.","displayOptions":{"show":{"resource":["contact"],"operation":["lookup"]}},"default":""},{"displayName":"Phone","name":"phone","type":"string","description":"Lookup Contact by Phone. It will first try to find a contact by Email and than by Phone.","displayOptions":{"show":{"resource":["contact"],"operation":["lookup"]}},"default":""},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["opportunity"]}},"options":[{"name":"Create","value":"create","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"=/pipelines/{{$parameter.pipelineId}}/opportunities"}},"action":"Create an opportunity"},{"name":"Delete","value":"delete","routing":{"request":{"method":"DELETE","url":"=/pipelines/{{$parameter.pipelineId}}/opportunities/{{$parameter.opportunityId}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"action":"Delete an opportunity"},{"name":"Get","value":"get","routing":{"request":{"method":"GET","url":"=/pipelines/{{$parameter.pipelineId}}/opportunities/{{$parameter.opportunityId}}"}},"action":"Get an opportunity"},{"name":"Get Many","value":"getAll","routing":{"request":{"method":"GET","url":"=/pipelines/{{$parameter.pipelineId}}/opportunities"},"send":{"paginate":true}},"action":"Get many opportunities"},{"name":"Update","value":"update","routing":{"request":{"method":"PUT","url":"=/pipelines/{{$parameter.pipelineId}}/opportunities/{{$parameter.opportunityId}}"},"send":{"preSend":[null,null]}},"action":"Update an opportunity"}],"default":"create"},{"displayName":"Pipeline Name or ID","name":"pipelineId","type":"options","displayOptions":{"show":{"resource":["opportunity"],"operation":["create","delete","get","getAll","update"]}},"description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptions":{"routing":{"request":{"url":"/pipelines","method":"GET"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"pipelines"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"default":""},{"displayName":"Stage Name or ID","name":"stageId","type":"options","required":true,"description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}},"default":"","typeOptions":{"loadOptionsDependsOn":["pipelineId"],"loadOptionsMethod":"getPipelineStages"},"routing":{"send":{"type":"body","property":"stageId"}}},{"displayName":"Contact Identifier","name":"contactIdentifier","required":true,"type":"string","description":"Either Email, Phone or Contact ID","hint":"There can only be one opportunity for each contact.","displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}},"default":"","routing":{"send":{"preSend":[null]}}},{"displayName":"Title","name":"title","type":"string","required":true,"displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}},"default":"","routing":{"send":{"type":"body","property":"title"}}},{"displayName":"Status","name":"status","type":"options","required":true,"displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}},"options":[{"name":"Open","value":"open"},{"name":"Won","value":"won"},{"name":"Lost","value":"lost"},{"name":"Abandoned","value":"abandoned"}],"default":"open","routing":{"send":{"type":"body","property":"status"}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}},"options":[{"displayName":"Assigned To","name":"assignedTo","type":"options","default":"","description":"Choose staff member from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"routing":{"send":{"type":"body","property":"assignedTo"}}},{"displayName":"Company Name","name":"companyName","type":"string","default":"","routing":{"send":{"type":"body","property":"companyName"}}},{"displayName":"Monetary Value","name":"monetaryValue","type":"number","default":"","description":"Monetary value of lead opportunity","routing":{"send":{"type":"body","property":"monetaryValue"}}},{"displayName":"Name","name":"name","type":"string","default":"","placeholder":"e.g. John Deo","routing":{"send":{"type":"body","property":"name"}}},{"displayName":"Tags","name":"tags","type":"string","hint":"Comma separated list of tags, array of strings can be set in expression","default":"","routing":{"send":{"type":"body","property":"tags"}}}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"hint":"You cannot update an opportunity's pipeline ID.","displayOptions":{"show":{"resource":["opportunity"],"operation":["update"]}},"default":""},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["update"]}},"options":[{"displayName":"Assigned To","name":"assignedTo","type":"options","default":"","description":"Choose staff member from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"routing":{"send":{"type":"body","property":"assignedTo"}}},{"displayName":"Company Name","name":"companyName","type":"string","default":"","routing":{"send":{"type":"body","property":"companyName"}}},{"displayName":"Contact Identifier","name":"contactIdentifier","type":"string","description":"Either Email, Phone or Contact ID","hint":"There can only be one opportunity for each contact.","default":"","routing":{"send":{"preSend":[null]}}},{"displayName":"Monetary Value","name":"monetaryValue","type":"number","default":"","description":"Monetary value of lead opportunity","routing":{"send":{"type":"body","property":"monetaryValue"}}},{"displayName":"Name","name":"name","type":"string","default":"","placeholder":"e.g. John Deo","routing":{"send":{"type":"body","property":"name"}}},{"displayName":"Stage Name or ID","name":"stageId","type":"options","default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["pipelineId"],"loadOptionsMethod":"getPipelineStages"},"routing":{"send":{"type":"body","property":"stageId"}}},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Open","value":"open"},{"name":"Won","value":"won"},{"name":"Lost","value":"lost"},{"name":"Abandoned","value":"abandoned"}],"default":"open","routing":{"send":{"type":"body","property":"status"}}},{"displayName":"Title","name":"title","type":"string","default":"","routing":{"send":{"type":"body","property":"title"}}},{"displayName":"Tags","name":"tags","type":"string","hint":"Comma separated list of tags, array of strings can be set in expression","default":"","routing":{"send":{"type":"body","property":"tags"}}}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"displayOptions":{"show":{"resource":["opportunity"],"operation":["delete"]}},"default":""},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"displayOptions":{"show":{"resource":["opportunity"],"operation":["get"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":20,"routing":{"send":{"type":"query","property":"limit"}},"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"]}},"options":[{"displayName":"Assigned To","name":"assignedTo","type":"options","default":"","description":"Choose staff member from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"routing":{"send":{"type":"query","property":"assignedTo"}}},{"displayName":"Campaign ID","name":"campaignId","type":"string","default":"","routing":{"send":{"type":"query","property":"campaignId"}}},{"displayName":"End Date","name":"endDate","type":"dateTime","default":"","routing":{"send":{"type":"query","property":"endDate","preSend":[null]}}},{"displayName":"Stage Name or ID","name":"stageId","type":"options","default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["pipelineId"],"loadOptionsMethod":"getPipelineStages"},"routing":{"send":{"type":"query","property":"stageId"}}},{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","routing":{"send":{"type":"query","property":"startDate","preSend":[null]}}},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Open","value":"open"},{"name":"Won","value":"won"},{"name":"Lost","value":"lost"},{"name":"Abandoned","value":"abandoned"}],"default":"open","routing":{"send":{"type":"query","property":"status"}}},{"displayName":"Query","name":"query","type":"string","default":"","description":"Query will search on these fields: Name, Phone, Email, Tags, and Company Name","routing":{"send":{"type":"query","property":"query"}}}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["task"]}},"options":[{"name":"Create","value":"create","routing":{"request":{"method":"POST","url":"=/contacts/{{$parameter.contactId}}/tasks"},"output":{"postReceive":[null]}},"action":"Create a task"},{"name":"Delete","value":"delete","routing":{"request":{"method":"DELETE","url":"=/contacts/{{$parameter.contactId}}/tasks/{{$parameter.taskId}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"action":"Delete a task"},{"name":"Get","value":"get","routing":{"request":{"method":"GET","url":"=/contacts/{{$parameter.contactId}}/tasks/{{$parameter.taskId}}"},"output":{"postReceive":[null]}},"action":"Get a task"},{"name":"Get Many","value":"getAll","routing":{"request":{"method":"GET","url":"=/contacts/{{$parameter.contactId}}/tasks"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"tasks"}},null]}},"action":"Get many tasks"},{"name":"Update","value":"update","routing":{"request":{"method":"PUT","url":"=/contacts/{{$parameter.contactId}}/tasks/{{$parameter.taskId}}"},"send":{"preSend":[null]},"output":{"postReceive":[null]}},"action":"Update a task"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"default":"","required":true,"description":"Contact the task belongs to"},{"displayName":"Title","name":"title","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"routing":{"send":{"type":"body","property":"title"}}},{"displayName":"Due Date","name":"dueDate","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"routing":{"send":{"type":"body","property":"dueDate","preSend":[null]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"options":[{"displayName":"Assigned To","name":"assignedTo","type":"options","default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"routing":{"send":{"type":"body","property":"assignedTo"}}},{"displayName":"Description","name":"description","type":"string","default":"","routing":{"send":{"type":"body","property":"description"}}},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Incompleted","value":"incompleted"},{"name":"Completed","value":"completed"}],"default":"incompleted","routing":{"send":{"type":"body","property":"status"}}}]},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"default":"","required":true,"description":"Contact the task belongs to"},{"displayName":"Task ID","name":"taskId","type":"string","displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"default":"","required":true},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"options":[{"displayName":"Assigned To","name":"assignedTo","type":"options","default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"routing":{"send":{"type":"body","property":"assignedTo"}}},{"displayName":"Description","name":"description","type":"string","default":"","routing":{"send":{"type":"body","property":"description"}}},{"displayName":"Due Date","name":"dueDate","type":"dateTime","default":"","routing":{"send":{"type":"body","property":"dueDate","preSend":[null]}}},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Incompleted","value":"incompleted"},{"name":"Completed","value":"completed"}],"default":"incompleted","routing":{"send":{"type":"body","property":"status"}}},{"displayName":"Title","name":"title","type":"string","default":"","routing":{"send":{"type":"body","property":"title"}}}]},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"resource":["task"],"operation":["delete"]}},"default":"","required":true,"description":"Contact the task belongs to"},{"displayName":"Task ID","name":"taskId","type":"string","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["delete"]}},"default":""},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"resource":["task"],"operation":["get"]}},"default":"","required":true,"description":"Contact the task belongs to"},{"displayName":"Task ID","name":"taskId","type":"string","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["get"]}},"default":""},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"default":"","required":true,"description":"Contact the task belongs to"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["task"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":20,"routing":{"send":{"type":"query","property":"limit"}},"description":"Max number of results to return"}]

operations:
  [{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"opportunity","name":"Opportunity"},{"type":"resource","resource":"task","name":"Task"},{"type":"operation","operation":"create","name":"Create or Update","action":"Create or update a contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"lookup","name":"Lookup","action":"Lookup a contact","resources":["contact"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact","resources":["contact"]},{"type":"operation","operation":"create","name":"Create","action":"Create an opportunity","resources":["opportunity"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an opportunity","resources":["opportunity"]},{"type":"operation","operation":"get","name":"Get","action":"Get an opportunity","resources":["opportunity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many opportunities","resources":["opportunity"]},{"type":"operation","operation":"update","name":"Update","action":"Update an opportunity","resources":["opportunity"]},{"type":"operation","operation":"create","name":"Create","action":"Create a task","resources":["task"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a task","resources":["task"]},{"type":"operation","operation":"get","name":"Get","action":"Get a task","resources":["task"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many tasks","resources":["task"]},{"type":"operation","operation":"update","name":"Update","action":"Update a task","resources":["task"]}]


node_type: homeAssistant
package_name: n8n-nodes-base
display_name: Home Assistant
description: Consume Home Assistant API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"homeAssistantApi","required":true,"testedBy":"homeAssistantApiTest"}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Home Assistant node documentation
  description: Learn how to use the Home Assistant node in n8n. Follow technical documentation to integrate Home Assistant node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Home Assistant node

  Use the Home Assistant node to automate work in Home Assistant, and integrate Home Assistant with other applications. n8n has built-in support for a wide range of Home Assistant features, including getting, creating, and checking camera proxies, configurations, logs, services, and templates. 

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

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

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

  ## Operations

  * Camera Proxy
      * Get the camera screenshot
  * Config
      * Get the configuration
      * Check the configuration
  * Event
      * Create an event
      * Get all events
  * Log
      * Get a log for a specific entity
      * Get all logs
  * Service
      * Call a service within a specific domain
      * Get all services
  * State
      * Create a new record, or update the current one if it already exists (upsert)
      * Get a state for a specific entity
      * Get all states
  * Template
      * Create a template

  ## Templates and examples

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

  ## Related resources

  Refer to [Home Assistant's documentation](https://developers.home-assistant.io/docs/api/rest/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Camera Proxy","value":"cameraProxy"},{"name":"Config","value":"config"},{"name":"Event","value":"event"},{"name":"Log","value":"log"},{"name":"Service","value":"service"},{"name":"State","value":"state"},{"name":"Template","value":"template"}],"default":"config"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["cameraProxy"]}},"options":[{"name":"Get Screenshot","value":"getScreenshot","description":"Get the camera screenshot","action":"Get a screenshot"}],"default":"getScreenshot"},{"displayName":"Camera Entity Name or ID","name":"cameraEntityId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCameraEntities"},"default":"","required":true,"displayOptions":{"show":{"operation":["getScreenshot"],"resource":["cameraProxy"]}}},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","required":true,"default":"data","displayOptions":{"show":{"operation":["getScreenshot"],"resource":["cameraProxy"]}},"description":"Name of the binary property to which to write the data of the read file"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["config"]}},"options":[{"name":"Get","value":"get","description":"Get the configuration","action":"Get the config"},{"name":"Check Configuration","value":"check","description":"Check the configuration","action":"Check the config"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["event"]}},"options":[{"name":"Create","value":"create","description":"Create an event","action":"Create an event"},{"name":"Get Many","value":"getAll","description":"Get many events","action":"Get many events"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["event"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["event"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Event Type","name":"eventType","type":"string","displayOptions":{"show":{"operation":["create"],"resource":["event"]}},"required":true,"default":"","description":"The Entity ID for which an event will be created"},{"displayName":"Event Attributes","name":"eventAttributes","type":"fixedCollection","typeOptions":{"multipleValues":true},"placeholder":"Add Attribute","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["create"]}},"options":[{"displayName":"Attributes","name":"attributes","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the attribute"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the attribute"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["history"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many state changes","action":"Get many state changes"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["history"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["history"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["history"],"operation":["getAll"]}},"options":[{"displayName":"End Time","name":"endTime","type":"dateTime","default":"","description":"The end of the period"},{"displayName":"Entity IDs","name":"entityIds","type":"string","default":"","description":"The entities IDs separated by comma"},{"displayName":"Minimal Response","name":"minimalResponse","type":"boolean","default":false,"description":"Whether to only return <code>last_changed</code> and state for states"},{"displayName":"Significant Changes Only","name":"significantChangesOnly","type":"boolean","default":false,"description":"Whether to only return significant state changes"},{"displayName":"Start Time","name":"startTime","type":"dateTime","default":"","description":"The beginning of the period"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["log"]}},"options":[{"name":"Get Error Logs","value":"getErroLogs","description":"Get a log for a specific entity","action":"Get a log for an entity"},{"name":"Get Logbook Entries","value":"getLogbookEntries","description":"Get all logs","action":"Get all logs for an entity"}],"default":"getErroLogs"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["log"],"operation":["getLogbookEntries"]}},"options":[{"displayName":"End Time","name":"endTime","type":"dateTime","default":"","description":"The end of the period"},{"displayName":"Entity ID","name":"entityId","type":"string","default":""},{"displayName":"Start Time","name":"startTime","type":"dateTime","default":"","description":"The beginning of the period"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["service"]}},"options":[{"name":"Call","value":"call","description":"Call a service within a specific domain","action":"Call a service"},{"name":"Get Many","value":"getAll","description":"Get many services","action":"Get many services"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["service"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["service"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Domain Name or ID","name":"domain","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getDomains"},"default":"","required":true,"displayOptions":{"show":{"resource":["service"],"operation":["call"]}}},{"displayName":"Service Name or ID","name":"service","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["domain"],"loadOptionsMethod":"getDomainServices"},"default":"","required":true,"displayOptions":{"show":{"resource":["service"],"operation":["call"]}}},{"displayName":"Service Attributes","name":"serviceAttributes","type":"fixedCollection","typeOptions":{"multipleValues":true},"placeholder":"Add Attribute","default":{},"displayOptions":{"show":{"resource":["service"],"operation":["call"]}},"options":[{"name":"attributes","displayName":"Attributes","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the field"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the field"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["state"]}},"options":[{"name":"Create or Update","value":"upsert","description":"Create a new record, or update the current one if it already exists (upsert)","action":"Create or update a state"},{"name":"Get","value":"get","description":"Get a state for a specific entity","action":"Get a state"},{"name":"Get Many","value":"getAll","description":"Get many states","action":"Get many states"}],"default":"get"},{"displayName":"Entity Name or ID","name":"entityId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getAllEntities"},"displayOptions":{"show":{"operation":["get"],"resource":["state"]}},"required":true,"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["state"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["state"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Entity Name or ID","name":"entityId","type":"options","typeOptions":{"loadOptionsMethod":"getAllEntities"},"displayOptions":{"show":{"operation":["upsert"],"resource":["state"]}},"required":true,"default":"","description":"The entity ID for which a state will be created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"State","name":"state","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["state"],"operation":["upsert"]}}},{"displayName":"State Attributes","name":"stateAttributes","type":"fixedCollection","typeOptions":{"multipleValues":true},"placeholder":"Add Attribute","default":{},"displayOptions":{"show":{"resource":["state"],"operation":["upsert"]}},"options":[{"displayName":"Attributes","name":"attributes","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the attribute"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the attribute"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["template"]}},"options":[{"name":"Create","value":"create","description":"Create a template","action":"Create a template"}],"default":"create"},{"displayName":"Template","name":"template","type":"string","displayOptions":{"show":{"resource":["template"],"operation":["create"]}},"required":true,"default":"","description":"Render a Home Assistant template. <a href=\"https://www.home-assistant.io/docs/configuration/templating/\">See template docs for more information.</a>."}]

operations:
  [{"type":"resource","resource":"cameraProxy","name":"Camera Proxy"},{"type":"resource","resource":"config","name":"Config"},{"type":"resource","resource":"event","name":"Event"},{"type":"resource","resource":"log","name":"Log"},{"type":"resource","resource":"service","name":"Service"},{"type":"resource","resource":"state","name":"State"},{"type":"resource","resource":"template","name":"Template"},{"type":"operation","operation":"getScreenshot","name":"Get Screenshot","action":"Get a screenshot","resources":["cameraProxy"]},{"type":"operation","operation":"get","name":"Get","action":"Get the config","resources":["config"]},{"type":"operation","operation":"check","name":"Check Configuration","action":"Check the config","resources":["config"]},{"type":"operation","operation":"create","name":"Create","action":"Create an event","resources":["event"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many events","resources":["event"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many state changes","resources":["history"]},{"type":"operation","operation":"getErroLogs","name":"Get Error Logs","action":"Get a log for an entity","resources":["log"]},{"type":"operation","operation":"getLogbookEntries","name":"Get Logbook Entries","action":"Get all logs for an entity","resources":["log"]},{"type":"operation","operation":"call","name":"Call","action":"Call a service","resources":["service"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many services","resources":["service"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a state","resources":["state"]},{"type":"operation","operation":"get","name":"Get","action":"Get a state","resources":["state"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many states","resources":["state"]},{"type":"operation","operation":"create","name":"Create","action":"Create a template","resources":["template"]}]


node_type: htmlExtract
package_name: n8n-nodes-base
display_name: HTML Extract
description: Extracts data from HTML
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Source Data","name":"sourceData","type":"options","options":[{"name":"Binary","value":"binary"},{"name":"JSON","value":"json"}],"default":"json","description":"If HTML should be read from binary or JSON data"},{"displayName":"Binary Property","name":"dataPropertyName","type":"string","displayOptions":{"show":{"sourceData":["binary"]}},"default":"data","required":true,"description":"Name of the binary property in which the HTML to extract the data from can be found"},{"displayName":"JSON Property","name":"dataPropertyName","type":"string","displayOptions":{"show":{"sourceData":["json"]}},"default":"data","required":true,"description":"Name of the JSON property in which the HTML to extract the data from can be found. The property can either contain a string or an array of strings."},{"displayName":"Extraction Values","name":"extractionValues","placeholder":"Add Value","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"values","displayName":"Values","values":[{"displayName":"Key","name":"key","type":"string","default":"","description":"The key under which the extracted value should be saved"},{"displayName":"CSS Selector","name":"cssSelector","type":"string","default":"","placeholder":".price","description":"The CSS selector to use"},{"displayName":"Return Value","name":"returnValue","type":"options","options":[{"name":"Attribute","value":"attribute","description":"Get an attribute value like \"class\" from an element"},{"name":"HTML","value":"html","description":"Get the HTML the element contains"},{"name":"Text","value":"text","description":"Get only the text content of the element"},{"name":"Value","value":"value","description":"Get value of an input, select or textarea"}],"default":"text","description":"What kind of data should be returned"},{"displayName":"Attribute","name":"attribute","type":"string","displayOptions":{"show":{"returnValue":["attribute"]}},"default":"","placeholder":"class","description":"The name of the attribute to return the value off"},{"displayName":"Return Array","name":"returnArray","type":"boolean","default":false,"description":"Whether to return the values as an array so if multiple ones get found they also get returned separately. If not set all will be returned as a single string."}]}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Trim Values","name":"trimValues","type":"boolean","default":true,"description":"Whether to remove automatically all spaces and newlines from the beginning and end of the values"}]}]


node_type: html
package_name: n8n-nodes-base
display_name: HTML
description: Work with HTML
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HTML
  description: Documentation for the HTML node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # HTML

  The HTML node provides operations to help you work with HTML in n8n.

  /// note | HTML Extract node
  The HTML node replaces the HTML Extract node from version 0.213.0 on. If you're using an older version of n8n, you can still view the [HTML Extract node documentation](https://github.com/n8n-io/n8n-docs/blob/86fe33b681621e618e3adcab9a27e8605dbc23ad/docs/integrations/builtin/core-nodes/n8n-nodes-base.htmlextract.md){:target=_blank .external-link}.
  ///
  /// warning | Cross-site scripting
  When using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/){:target=_blank .external-link}. This is a security risk. Be careful with un-trusted inputs.
  ///

  ## Operations

  * [**Generate HTML template**](#generate-html-template): Use this operation to create an HTML template. This allows you to take data from your workflow and output it as HTML.
  * [**Extract HTML content**](#extract-html-content): Extract contents from an HTML-formatted source. The source can be in JSON or a binary file (`.html`).
  * [**Convert to HTML Table**](#convert-to-html-table): Convert content to an HTML table.

  The node parameters and options depend on the operation you select. Refer to the sections below for more details on configuring each operation.

  ## Generate HTML template

  Create an HTML template. This allows you to take data from your workflow and output it as HTML. 

  You can include:

  * Standard HTML
  * CSS in `<style>` tags.
  * JavaScript in `<script>` tags. n8n doesn't execute the JavaScript.
  * Expressions, wrapped in `{{}}`.

  You can use [Expressions](/code/expressions.md) in the template, including n8n's [Built-in methods and variables](/code/builtin/overview.md). 

  ## Extract HTML Content

  Extract contents from an HTML-formatted source. The source can be in JSON or a binary file (`.html`).

  Use these parameters:

  ### Source Data

  Select the source type for your HTML content. Choose between:

  * **JSON**: If you select this source data, enter the **JSON Property**: the name of the input containing the HTML you want to extract. The property can contain a string or an array of strings.
  * **Binary**: If you select this source data, enter the **Input Binary Field**: the name of the input containing the HTML you want to extract. The property can contain a string or an array of strings.

  ### Extraction Values

  - **Key**: Enter the key to save the extracted value under.
  - **CSS Selector**: Enter the CSS selector to search for.
  - **Return Value**: Select the type of data to return. Choose from:
  	- **Attribute**: Return an attribute value like `class` from an element.
  		- If you select this option, enter the name of the **Attribute** to return the value of.
  	- **HTML**: Return the HTML that the element contains.
  	- **Text**: Return the text content of the element.
  		- If you choose this option, you can also enter a comma-separated list of selectors to skip in the **Skip Selectors**.
  	- **Value**: Return the value of an input, select, or text area.
  - **Return Array**: Choose whether to return multiple extraction values as an array (turned on) or as a single string (turned off).

  ### Extract HTML Content options

  You can also configure this operation with these options:

  * **Trim Values**: Controls whether to remove all spaces and newlines from the beginning and end of the values (turned on) or leaves them (turned off).
  * **Clean Up Text**: Controls whether to remove leading whitespaces, trailing whitespaces, and line breaks (newlines) and condense multiple consecutive whitespaces into a single space (turned on) or to leave them as-is (turned off).

  ## Convert to HTML Table

  This operation expects data from another node. It has no parameters. It includes these options:

  * **Capitalize Headers**: Controls whether to capitalize the table's headers (turned on) or not (turned off).
  * **Custom Styling**: Controls whether to use custom styling (turned on) or not (turned off).
  * **Caption**: Enter a caption to add to the table.
  * **Table Attributes**: Enter any attributes to apply to the `<table>`, such as style attributes.
  * **Header Attributes**: Enter any attributes to apply to the table's headers `<th>`.
  * **Row Attributes**: Enter any attributes to apply to the table's rows `<tr>`.
  * **Cell Attributes**: Enter any attributes to apply to the table's cells `<td>`.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Generate HTML Template","value":"generateHtmlTemplate","action":"Generate HTML template"},{"name":"Extract HTML Content","value":"extractHtmlContent","action":"Extract HTML Content"},{"name":"Convert to HTML Table","value":"convertToHtmlTable","action":"Convert to HTML Table"}],"default":"generateHtmlTemplate"},{"displayName":"HTML Template","name":"html","typeOptions":{"editor":"htmlEditor"},"type":"string","default":"<!DOCTYPE html>\n\n<html>\n<head>\n  <meta charset=\"UTF-8\" />\n  <title>My HTML document</title>\n</head>\n<body>\n  <div class=\"container\">\n    <h1>This is an H1 heading</h1>\n    <h2>This is an H2 heading</h2>\n    <p>This is a paragraph</p>\n  </div>\n</body>\n</html>\n\n<style>\n.container {\n  background-color: #ffffff;\n  text-align: center;\n  padding: 16px;\n  border-radius: 8px;\n}\n\nh1 {\n  color: #ff6d5a;\n  font-size: 24px;\n  font-weight: bold;\n  padding: 8px;\n}\n\nh2 {\n  color: #909399;\n  font-size: 18px;\n  font-weight: bold;\n  padding: 8px;\n}\n</style>\n\n<script>\nconsole.log(\"Hello World!\");\n</script>","noDataExpression":true,"description":"HTML template to render","displayOptions":{"show":{"operation":["generateHtmlTemplate"]}}},{"displayName":"<b>Tips</b>: Type ctrl+space for completions. Use <code>{{ }}</code> for expressions and <code>&lt;style&gt;</code> tags for CSS. JS in <code>&lt;script&gt;</code> tags is included but not executed in n8n.","name":"notice","type":"notice","default":"","displayOptions":{"show":{"operation":["generateHtmlTemplate"]}}},{"displayName":"Source Data","name":"sourceData","type":"options","options":[{"name":"Binary","value":"binary"},{"name":"JSON","value":"json"}],"default":"json","description":"If HTML should be read from binary or JSON data","displayOptions":{"show":{"operation":["extractHtmlContent"]}}},{"displayName":"Binary Property","name":"dataPropertyName","type":"string","requiresDataPath":"single","displayOptions":{"show":{"operation":["extractHtmlContent"],"sourceData":["binary"]}},"default":"data","required":true,"description":"Name of the binary property in which the HTML to extract the data from can be found"},{"displayName":"JSON Property","name":"dataPropertyName","type":"string","requiresDataPath":"single","displayOptions":{"show":{"operation":["extractHtmlContent"],"sourceData":["json"]}},"default":"data","required":true,"description":"Name of the JSON property in which the HTML to extract the data from can be found. The property can either contain a string or an array of strings."},{"displayName":"Extraction Values","name":"extractionValues","placeholder":"Add Value","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["extractHtmlContent"]}},"default":{},"options":[{"name":"values","displayName":"Values","values":[{"displayName":"Key","name":"key","type":"string","default":"","description":"The key under which the extracted value should be saved"},{"displayName":"CSS Selector","name":"cssSelector","type":"string","default":"","placeholder":".price","description":"The CSS selector to use"},{"displayName":"Return Value","name":"returnValue","type":"options","options":[{"name":"Attribute","value":"attribute","description":"Get an attribute value like \"class\" from an element"},{"name":"HTML","value":"html","description":"Get the HTML the element contains"},{"name":"Text","value":"text","description":"Get only the text content of the element"},{"name":"Value","value":"value","description":"Get value of an input, select or textarea"}],"default":"text","description":"What kind of data should be returned"},{"displayName":"Attribute","name":"attribute","type":"string","displayOptions":{"show":{"returnValue":["attribute"]}},"default":"","placeholder":"class","description":"The name of the attribute to return the value off"},{"displayName":"Return Array","name":"returnArray","type":"boolean","default":false,"description":"Whether to return the values as an array so if multiple ones get found they also get returned separately. If not set all will be returned as a single string."}]}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["extractHtmlContent"]}},"options":[{"displayName":"Trim Values","name":"trimValues","type":"boolean","default":true,"description":"Whether to remove automatically all spaces and newlines from the beginning and end of the values"}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["convertToHtmlTable"]}},"options":[{"displayName":"Capitalize Headers","name":"capitalize","type":"boolean","default":false,"description":"Whether to capitalize the headers"},{"displayName":"Custom Styling","name":"customStyling","type":"boolean","default":false,"description":"Whether to use custom styling"},{"displayName":"Caption","name":"caption","type":"string","default":"","description":"Caption to add to the table"},{"displayName":"Table Attributes","name":"tableAttributes","type":"string","default":"","description":"Attributes to attach to the table","placeholder":"e.g. style=\"padding:10px\""},{"displayName":"Header Attributes","name":"headerAttributes","type":"string","default":"","description":"Attributes to attach to the table header","placeholder":"e.g. style=\"padding:10px\""},{"displayName":"Row Attributes","name":"rowAttributes","type":"string","default":"","description":"Attributes to attach to the table row","placeholder":"e.g. style=\"padding:10px\""},{"displayName":"Cell Attributes","name":"cellAttributes","type":"string","default":"","description":"Attributes to attach to the table cell","placeholder":"e.g. style=\"padding:10px\""}]}]


node_type: httpRequest
package_name: n8n-nodes-base
display_name: HTTP Request
description: Makes an HTTP request and returns the response data
category: output
development_style: programmatic
version: 1
properties_schema: []
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HTTP Request node documentation
  description: Learn how to use the HTTP Request node in n8n. Follow technical documentation to integrate HTTP Request node into your workflows.
  contentType: [integration, reference]
  priority: critical
  ---

  # HTTP Request node

  The HTTP Request node is one of the most versatile nodes in n8n. It allows you to make HTTP requests to query data from any app or service with a REST API. You can use the HTTP Request node a regular node or attached to an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md) to use as a [tool](/advanced-ai/examples/understand-tools.md){ data-preview }.

  When using this node, you're creating a REST API call. You need some understanding of basic API terminology and concepts.

  There are two ways to create an HTTP request: configure the [node parameters](#node-parameters) or [import a curl command](#import-curl-command).

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

  ## Node parameters

  ### Method

  Select the method to use for the request:

  - DELETE
  - GET
  - HEAD
  - OPTIONS
  - PATCH
  - POST
  - PUT

  ### URL

  Enter the endpoint you want to use.

  ### Authentication

  n8n recommends using the **Predefined Credential Type** option when it's available. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.

  #### Predefined credentials

  Credentials for integrations supported by n8n, including both built-in and community nodes. Use **Predefined Credential Type** for custom operations without extra setup. Refer to [Custom API operations](/integrations/custom-operations.md) for more information.

  #### Generic credentials

  Credentials for integrations not supported by n8n. You'll need to manually configure the authentication process, including specifying the required API endpoints, necessary parameters, and the authentication method. 

  You can select one of the following methods:

  * Basic auth
  * Custom auth
  * Digest auth
  * Header auth
  * OAuth1 API
  * OAuth2 API
  * Query auth

  Refer to [HTTP request credentials](/integrations/builtin/credentials/httprequest.md) for more information on setting up each credential type.

  ### Send Query Parameters

  Query parameters act as filters on HTTP requests. If the API you're interacting with supports them and the request you're making needs a filter, turn this option on.

  **Specify your query parameters** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Query Parameters**. To enter more query parameter name/value pairs, select **Add Parameter**. The name is the name of the field you're filtering on, and the value is the filter value.
  * **Using JSON**: Enter **JSON** to define your query parameters.

  Refer to your service's API documentation for detailed guidance.

  ### Send Headers

  Use this parameter to send headers with your request. Headers contain metadata or context about your request.

  **Specify Headers** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Header Parameters**. To enter more header parameter name/value pairs, select **Add Parameter**. The name is the header you wish to set, and the value is the value you want to pass for that header.
  * **Using JSON**: Enter **JSON** to define your header parameters.

  Refer to your service's API documentation for detailed guidance.

  ### Send Body

  If you need to send a body with your API request, turn this option on.

  Then select the **Body Content Type** that best matches the format for the body content you wish to send.

  <!-- vale Vale.Spelling = NO -->
  #### Form URLencoded
  <!-- vale Vale.Spelling = YES -->

  Use this option to send your body as `application/x-www-form-urlencoded`.

  **Specify Body** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Body Parameters**. To enter more body parameter name/value pairs, select **Add Parameter**. The name should be the form field name, and the value is what you wish to set that field to.
  * **Using Single Field**: Enter your name/value pairs in a single **Body** parameter with format `fieldname1=value1&fieldname2=value2`.

  Refer to your service's API documentation for detailed guidance.

  #### Form-Data

  Use this option to send your body as `multipart/form-data`.

  Configure your **Body Parameters** by selecting the **Parameter Type**:

  * Choose **Form Data** to enter **Name**/**Value** pairs.
  * Choose **n8n Binary File** to pull the body from a file the node has access to.
      * **Name**: Enter the ID of the field to set.
      * **Input Data Field Name**: Enter the name of the incoming field containing the binary file data you want to process.

  Select **Add Parameter** to enter more parameters.

  Refer to your service's API documentation for detailed guidance.

  #### JSON

  Use this option to send your body as JSON.

  **Specify Body** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Body Parameters**. To enter more body parameter name/value pairs, select **Add Parameter**.
  * **Using JSON**: Enter **JSON** to define your body.

  Refer to your service's API documentation for detailed guidance.

  #### n8n Binary File

  Use this option to send the contents of a file stored in n8n as the body.

  Enter the name of the incoming field that contains the file as the **Input Data Field Name**.

  Refer to your service's API documentation for detailed guidance on how to format the file.

  #### Raw

  Use this option to send raw data in the body.

  * **Content Type**: Enter the `Content-Type` header to use for the raw body content. Refer to the IANA [Media types](https://www.iana.org/assignments/media-types/media-types.xhtml){:target=_blank .external-link} documentation for a full list of MIME content types.
  * **Body**: Enter the raw body content to send.

  Refer to your service's API documentation for detailed guidance.

  ## Node options

  Select **Add Option** to view and select these options. Options are available to all parameters unless otherwise noted.

  ### Array Format in Query Parameters

  /// note | Option availability
  This option is only available when you turn on **Send Query Parameters**.
  ///

  Use this option to control the format for arrays included in query parameters. Choose from these options:

  * **No Brackets**: Arrays will format as the name=value for each item in the array, for example: `foo=bar&foo=qux`.
  * **Brackets Only**: The node adds square brackets after each array name, for example: `foo[]=bar&foo[]=qux`.
  * **Brackets with Indices**: The node adds square brackets with an index value after each array name, for example: `foo[0]=bar&foo[1]=qux`.

  Refer to your service's API documentation for guidance on which option to use.

  ### Batching

  Control how to batch large numbers of input items:

  * **Items per Batch**: Enter the number of input items to include in each batch.
  * **Batch Interval**: Enter the time to wait between each batch of requests in milliseconds. Enter 0 for no batch interval.

  ### Ignore SSL Issues

  By default, n8n only downloads the response if SSL certificate validation succeeds. If you'd like to download the response even if SSL certificate validation fails, turn this option on.

  ### Lowercase Headers

  Choose whether to lowercase header names (turned on, default) or not (turned off).

  ### Redirects

  Choose whether to follow redirects (turned on by default) or not (turned off). If turned on, enter the maximum number of redirects the request should follow in **Max Redirects**.

  ### Response

  Use this option to set some details about the expected API response, including:

  * **Include Response Headers and Status**: By default, the node returns only the body. Turn this option on to return the full response (headers and response status code) as well as the body.
  * **Never Error**: By default, the node returns success only when the response returns with a 2xx code. Turn this option on to return success regardless of the code returned.
  * **Response Format**: Select the format in which the data gets returned. Choose from:
      * **Autodetect** (default): The node detects and formats the response based on the data returned.
      * **File**: Select this option to put the response into a file. Enter the field name where you want the file returned in **Put Output in Field**.
      * **JSON**: Select this option to format the response as JSON.
      * **Text**: Select this option to format the response as plain text. Enter the field name where you want the file returned in **Put Output in Field**.

  ### Pagination

  Use this option to paginate results, useful for handling query results that are too big for the API to return in a single call.

  /// note | Inspect the API data first
  Some options for pagination require knowledge of the data returned by the API you're using. Before setting up pagination, either check the API documentation, or do an API call without pagination, to see the data it returns.
  ///
  ??? Details "Understand pagination"
      Pagination means splitting a large set of data into multiple pages. The amount of data on each page depends on the limit you set.
    
      For example, you make an API call to an endpoint called `/users`. The API wants to send back information on 300 users, but this is too much data for the API to send in one response. 
    
      If the API supports pagination, you can incrementally fetch the data. To do this, you call `/users` with a pagination limit, and a page number or URL to tell the API which page to send. In this example, say you use a limit of 10, and start from page 0. The API sends the first 10 users in its response. You then call the API again, increasing the page number by 1, to get the next 10 results.

  Configure the pagination settings:

  * **Pagination Mode**:
      * **Off**: Turn off pagination.
      * **Update a Parameter in Each Request**: Use this when you need to dynamically set parameters for each request.
      * **Response Contains Next URL**: Use this when the API response includes the URL of the next page. Use an expression to set **Next URL**.

  For example setups, refer to [HTTP Request node cookbook | Pagination](/code/cookbook/http-node/pagination.md).

  n8n provides built-in variables for working with HTTP node requests and responses when using pagination:

  --8<-- "_snippets/integrations/builtin/core-nodes/http/pagination-variables.md"

  --8<-- "_snippets/integrations/builtin/core-nodes/http/pagination-api-differences.md"

  ### Proxy

  Use this option if you need to specify an HTTP proxy.

  Enter the **Proxy** the request should use.

  ### Timeout

  Use this option to set how long the node should wait for the server to send response headers (and start the response body). The node aborts requests that exceed this value for the initial response.

  Enter the **Timeout** time to wait in milliseconds.

  ## Tool-only options

  The following options are only available when attached to an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md) as a [tool](/advanced-ai/examples/understand-tools.md){ data-preview }.

  ### Optimize Response

  Whether to optimize the tool response to reduce the amount of data passed to the LLM. Optimizing the response can reduce costs and can help the LLM ignore unimportant details, often leading to better results.

  When optimizing responses, you select an expected response type, which determines other options you can configure. The supported response types are:

  #### JSON

  When expecting a **JSON** response, you can configure which parts of the JSON data to use as a response with the following choices:

  * **Field Containing Data**: This field identifies a specific part of the JSON object that contains your relevant data. You can leave this blank to use the entire response.
  * **Include Fields**: This is how you choose which fields you want in your response object. There are three choices:
  	* **All**: Include all fields in the response object.
  	* **Selected**: Include only the fields specified below.
  		* **Fields**: A comma-separated list of fields to include in the response. You can use dot notation to specify nested fields. You can drag fields from the Input panel to add them to the field list.
  	* **Exclude**: Include all fields *except* the fields specified below.
  		* **Fields**: A comma-separated list of fields to exclude from the response. You can use dot notation to specify nested fields. You can drag fields from the Input panel to add them to the field list.

  #### HTML

  When expecting **HTML**, you can identify the part of an HTML document relevant to the LLM and optimize the response with the following options:

  * **Selector (CSS)**: A specific element or element type to include in the response HTML. Uses the `body` element by default.
  * **Return Only Content**: Whether to strip HTML tags and attributes from the response, leaving only the actual content. This uses fewer tokens and may be easier for the model to understand.
  	* **Elements To Omit**: A comma-separated list of CSS selectors to exclude when extracting content.
  * **Truncate Response**: Whether to limit the response size to save tokens.
  	* **Max Response Characters**: The maximum number of characters to include in the HTML response. The default value is 1000.

  #### Text

  When expecting a generic **Text** response, you can optimize the results with the following options:

  * **Truncate Response**: Whether to limit the response size to save tokens.
  	* **Max Response Characters**: The maximum number of characters to include in the HTML response. The default value is 1000.

  ## Import curl command

  [curl](https://curl.se/){:target=_blank .external-link} is a command line tool and library for transferring data with URLs.

  You can use curl to call REST APIs. If the API documentation of the service you want to use provides curl examples, you can copy them out of the documentation and into n8n to configure the HTTP Request node.

  Import a curl command:

  1. From the HTTP Request node's **Parameters** tab, select **Import cURL**. The **Import cURL command** modal opens.
  2. Paste your curl command into the text box.
  3. Select **Import**. n8n loads the request configuration into the node fields. This overwrites any existing configuration.

  ## Templates and examples

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

  ## Common issues

  For common questions or issues and suggested solutions, refer to [Common Issues](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/common-issues.md).


node_type: hubspot
package_name: n8n-nodes-base
display_name: HubSpot
description: Consume HubSpot API
category: output
development_style: programmatic
version: 1
properties_schema: []
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HubSpot node documentation
  description: Learn how to use the HubSpot node in n8n. Follow technical documentation to integrate HubSpot node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # HubSpot node

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

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

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

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

  ## Operations

  * Contact
      * Create/Update a contact
      * Delete a contact
      * Get a contact
      * Get all contacts
      * Get recently created/updated contacts
      * Search contacts
  * Contact List
      * Add contact to a list
      * Remove a contact from a list
  * Company
      * Create a company
      * Delete a company
      * Get a company
      * Get all companies
      * Get recently created companies
      * Get recently modified companies
      * Search companies by domain
      * Update a company
  * Deal
      * Create a deal
      * Delete a deal
      * Get a deal
      * Get all deals
      * Get recently created deals
      * Get recently modified deals
      * Search deals
      * Update a deal
  * Engagement
      * Create an engagement
      * Delete an engagement
      * Get an engagement
      * Get all engagements
  * Form
      * Get all fields from a form
      * Submit data to a form
  * Ticket
      * Create a ticket
      * Delete a ticket
      * Get a ticket
      * Get all tickets
      * Update a ticket

  ## Templates and examples

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

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


node_type: hubspotTrigger
package_name: n8n-nodes-base
display_name: HubSpot Trigger
description: Starts the workflow when HubSpot events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"hubspotDeveloperApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HubSpot Trigger node documentation
  description: Learn how to use the HubSpot Trigger node in n8n. Follow technical documentation to integrate HubSpot Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # HubSpot Trigger node

  [HubSpot](https://www.hubspot.com/){:target=_blank .external-link} provides tools for social media marketing, content management, web analytics, landing pages, customer support, and search engine optimization.

  /// warning | Webhooks
  If you activate a second trigger, the previous trigger stops working. This is because the trigger registers a new webhook with HubSpot when activated. HubSpot only allows one webhook at a time. 
  ///

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

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

  ## Events

  * Company
  	* Created
  	* Deleted
  	* Property changed
  * Contact
  	* Created
  	* Deleted
  	* Privacy deleted
  	* Property changed
  * Conversation
  	* Created
  	* Deleted
  	* New message
  	* Privacy deletion
  	* Property changed
  * Deal
  	* Created
  	* Deleted
  	* Property changed
  * Ticket
  	* Created
  	* Deleted
  	* Property changed 

  ## Related resources

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

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

  Refer to [HubSpot's documentation](https://developers.hubspot.com/docs/api/overview){:target=_blank .external-link} for details about their API.

properties_schema:
  [{"displayName":"Events","name":"eventsUi","type":"fixedCollection","typeOptions":{"multipleValues":true},"placeholder":"Add Event","default":{},"options":[{"displayName":"Event","name":"eventValues","values":[{"displayName":"Name","name":"name","type":"options","options":[{"name":"Company Created","value":"company.creation","description":"To get notified if any company is created in a customer's account"},{"name":"Company Deleted","value":"company.deletion","description":"To get notified if any company is deleted in a customer's account"},{"name":"Company Property Changed","value":"company.propertyChange","description":"To get notified if a specified property is changed for any company in a customer's account"},{"name":"Contact Created","value":"contact.creation","description":"To get notified if any contact is created in a customer's account"},{"name":"Contact Deleted","value":"contact.deletion","description":"To get notified if any contact is deleted in a customer's account"},{"name":"Contact Privacy Deleted","value":"contact.privacyDeletion","description":"To get notified if a contact is deleted for privacy compliance reasons"},{"name":"Contact Property Changed","value":"contact.propertyChange","description":"To get notified if a specified property is changed for any contact in a customer's account"},{"name":"Conversation Creation","value":"conversation.creation","description":"To get notified if a new thread is created in an account"},{"name":"Conversation Deletion","value":"conversation.deletion","description":"To get notified if a thread is archived or soft-deleted in an account"},{"name":"Conversation New Message","value":"conversation.newMessage","description":"To get notified if a new message on a thread has been received"},{"name":"Conversation Privacy Deletion","value":"conversation.privacyDeletion","description":"To get notified if a thread is permanently deleted in an account"},{"name":"Conversation Property Change","value":"conversation.propertyChange","description":"To get notified if a property on a thread has been changed"},{"name":"Deal Created","value":"deal.creation","description":"To get notified if any deal is created in a customer's account"},{"name":"Deal Deleted","value":"deal.deletion","description":"To get notified if any deal is deleted in a customer's account"},{"name":"Deal Property Changed","value":"deal.propertyChange","description":"To get notified if a specified property is changed for any deal in a customer's account"},{"name":"Ticket Created","value":"ticket.creation","description":"To get notified if a ticket is created in a customer's account"},{"name":"Ticket Deleted","value":"ticket.deletion","description":"To get notified if any ticket is deleted in a customer's account"},{"name":"Ticket Property Changed","value":"ticket.propertyChange","description":"To get notified if a specified property is changed for any ticket in a customer's account"}],"default":"contact.creation","required":true},{"displayName":"Property Name or ID","name":"property","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["contact.propertyChange"],"loadOptionsMethod":"getContactProperties"},"displayOptions":{"show":{"name":["contact.propertyChange"]}},"default":"","required":true},{"displayName":"Property Name or ID","name":"property","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["company.propertyChange"],"loadOptionsMethod":"getCompanyProperties"},"displayOptions":{"show":{"name":["company.propertyChange"]}},"default":"","required":true},{"displayName":"Property Name or ID","name":"property","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["deal.propertyChange"],"loadOptionsMethod":"getDealProperties"},"displayOptions":{"show":{"name":["deal.propertyChange"]}},"default":"","required":true}]}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Max Concurrent Requests","name":"maxConcurrentRequests","type":"number","typeOptions":{"minValue":5},"default":5}]}]


node_type: humanticAi
package_name: n8n-nodes-base
display_name: Humantic AI
description: Consume Humantic AI API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"humanticAiApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Humantic AI node documentation
  description: Learn how to use the Humantic AI node in n8n. Follow technical documentation to integrate Humantic AI node into your workflows.
  contentType: [integration, reference]
  ---

  # Humantic AI node

  Use the Humantic AI node to automate work in Humantic AI, and integrate Humantic AI with other applications. n8n has built-in support for a wide range of Humantic AI features, including creating, retrieving, and updating profiles. 

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

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

  ## Operations

  * Profile
      * Create a profile
      * Retrieve a profile
      * Update a profile

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Profile","value":"profile"}],"default":"profile"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["profile"]}},"options":[{"name":"Create","value":"create","description":"Create a profile","action":"Create a profile"},{"name":"Get","value":"get","description":"Retrieve a profile","action":"Get a profile"},{"name":"Update","value":"update","description":"Update a profile","action":"Update a profile"}],"default":"create"},{"displayName":"User ID","name":"userId","type":"string","required":true,"default":"","displayOptions":{"show":{"operation":["create"],"resource":["profile"]}},"description":"The LinkedIn profile URL or email ID for creating a Humantic profile. If you are sending the resume, this should be a unique string."},{"displayName":"Send Resume","name":"sendResume","type":"boolean","default":false,"displayOptions":{"show":{"operation":["create"],"resource":["profile"]}},"description":"Whether to send a resume for a resume based analysis"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","displayOptions":{"show":{"operation":["create"],"resource":["profile"],"sendResume":[true]}},"description":"The resume in PDF or DOCX format"},{"displayName":"User ID","name":"userId","type":"string","required":true,"default":"","displayOptions":{"show":{"operation":["get"],"resource":["profile"]}},"description":"This value is the same as the User ID that was provided when the analysis was created. This could be a LinkedIn URL, email ID, or a unique string in case of resume based analysis."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["profile"]}},"options":[{"displayName":"Persona","name":"persona","type":"multiOptions","options":[{"name":"Sales","value":"sales"},{"name":"Hiring","value":"hiring"}],"default":[],"description":"Fetch the Humantic profile of the user for a particular persona type. Multiple persona values can be supported using comma as a delimiter."}]},{"displayName":"User ID","name":"userId","type":"string","required":true,"default":"","displayOptions":{"show":{"operation":["update"],"resource":["profile"]}},"description":"This value is the same as the User ID that was provided when the analysis was created. Currently only supported for profiles created using LinkedIn URL."},{"displayName":"Send Resume","name":"sendResume","type":"boolean","default":false,"displayOptions":{"show":{"operation":["update"],"resource":["profile"]}},"description":"Whether to send a resume for a resume of the user"},{"displayName":"Text","name":"text","type":"string","default":"","displayOptions":{"show":{"operation":["update"],"resource":["profile"],"sendResume":[false]}},"description":"Additional text written by the user"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","displayOptions":{"show":{"operation":["update"],"resource":["profile"],"sendResume":[true]}},"description":"The resume in PDF or DOCX format"}]

operations:
  [{"type":"resource","resource":"profile","name":"Profile"},{"type":"operation","operation":"create","name":"Create","action":"Create a profile","resources":["profile"]},{"type":"operation","operation":"get","name":"Get","action":"Get a profile","resources":["profile"]},{"type":"operation","operation":"update","name":"Update","action":"Update a profile","resources":["profile"]}]


node_type: hunter
package_name: n8n-nodes-base
display_name: Hunter
description: Consume Hunter API
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"hunterApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Hunter node documentation
  description: Learn how to use the Hunter node in n8n. Follow technical documentation to integrate Hunter node into your workflows.
  contentType: [integration, reference]
  ---

  # Hunter node

  Use the Hunter node to automate work in Hunter, and integrate Hunter with other applications. n8n has built-in support for a wide range of Hunter features, including getting, generating, and verifying email addresses. 

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

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

  ## Operations

  * Get every email address found on the internet using a given domain name, with sources
  * Generate or retrieve the most likely email address from a domain name, a first name and a last name
  * Verify the deliverability of an email address

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Domain Search","value":"domainSearch","description":"Get every email address found on the internet using a given domain name, with sources","action":"Get every email address found on the internet using a given domain name, with sources"},{"name":"Email Finder","value":"emailFinder","description":"Generate or retrieve the most likely email address from a domain name, a first name and a last name","action":"Generate or retrieve the most likely email address from a domain name, a first name and a last name"},{"name":"Email Verifier","value":"emailVerifier","description":"Verify the deliverability of an email address","action":"Verify the deliverability of an email address"}],"default":"domainSearch","description":"Operation to consume"},{"displayName":"Domain","name":"domain","type":"string","displayOptions":{"show":{"operation":["domainSearch"]}},"default":"","required":true,"description":"Domain name from which you want to find the email addresses. For example, \"stripe.com\"."},{"displayName":"Only Emails","name":"onlyEmails","type":"boolean","displayOptions":{"show":{"operation":["domainSearch"]}},"default":true,"description":"Whether to return only the the found emails"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["domainSearch"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["domainSearch"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"operation":["domainSearch"]}},"options":[{"displayName":"Type","name":"type","type":"options","default":"","options":[{"name":"Personal","value":"personal"},{"name":"Generic","value":"generic"}]},{"displayName":"Seniority","name":"seniority","type":"multiOptions","default":[],"options":[{"name":"Junior","value":"junior"},{"name":"Senior","value":"senior"},{"name":"Executive","value":"executive"}]},{"displayName":"Department","name":"department","type":"multiOptions","default":[],"options":[{"name":"Communication","value":"communication"},{"name":"Executive","value":"executive"},{"name":"Finance","value":"finance"},{"name":"HR","value":"hr"},{"name":"IT","value":"it"},{"name":"Legal","value":"legal"},{"name":"Management","value":"management"},{"name":"Marketing","value":"marketing"},{"name":"Sales","value":"sales"},{"name":"Support","value":"support"}]}]},{"displayName":"Domain","name":"domain","type":"string","default":"","displayOptions":{"show":{"operation":["emailFinder"]}},"required":true,"description":"Domain name from which you want to find the email addresses. For example, \"stripe.com\"."},{"displayName":"First Name","name":"firstname","type":"string","displayOptions":{"show":{"operation":["emailFinder"]}},"default":"","required":true,"description":"The person's first name. It doesn't need to be in lowercase."},{"displayName":"Last Name","name":"lastname","type":"string","displayOptions":{"show":{"operation":["emailFinder"]}},"default":"","required":true,"description":"The person's last name. It doesn't need to be in lowercase."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"operation":["emailVerifier"]}},"default":"","required":true,"description":"The email address you want to verify"}]


node_type: iCal
package_name: n8n-nodes-base
display_name: iCalendar
description: Create iCalendar file
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Create Event File","value":"createEventFile"}],"default":"createEventFile"},{"displayName":"Event Title","name":"title","type":"string","default":""},{"displayName":"Start","name":"start","type":"dateTime","default":"","required":true,"description":"Date and time at which the event begins. (For all-day events, the time will be ignored.)."},{"displayName":"End","name":"end","type":"dateTime","default":"","required":true,"description":"Date and time at which the event ends. (For all-day events, the time will be ignored.)."},{"displayName":"All Day","name":"allDay","type":"boolean","default":false,"description":"Whether the event lasts all day or not"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"description":"The field that your iCalendar file will be available under in the output"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["createEventFile"]}},"options":[{"displayName":"Attendees","name":"attendeesUi","type":"fixedCollection","typeOptions":{"multipleValues":true},"placeholder":"Add Attendee","default":{},"options":[{"displayName":"Attendees","name":"attendeeValues","values":[{"displayName":"Name","name":"name","type":"string","required":true,"default":""},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"default":""},{"displayName":"RSVP","name":"rsvp","type":"boolean","default":false,"description":"Whether the attendee has to confirm attendance or not"}]}]},{"displayName":"Busy Status","name":"busyStatus","type":"options","options":[{"name":"Busy","value":"BUSY"},{"name":"Tentative","value":"TENTATIVE"}],"default":"","description":"Used to specify busy status for Microsoft applications, like Outlook"},{"displayName":"Calendar Name","name":"calName","type":"string","default":"","description":"Specifies the calendar (not event) name. Used by Apple iCal and Microsoft Outlook (<a href=\"https://docs.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcical/1da58449-b97e-46bd-b018-a1ce576f3e6d\">spec</a>)."},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"File Name","name":"fileName","type":"string","default":"","description":"The name of the file to be generated. Default value is event.ics."},{"displayName":"Geolocation","name":"geolocationUi","type":"fixedCollection","typeOptions":{"multipleValues":false},"placeholder":"Add Geolocation","default":{},"options":[{"displayName":"Geolocation","name":"geolocationValues","values":[{"displayName":"Latitude","name":"lat","type":"string","default":""},{"displayName":"Longitude","name":"lon","type":"string","default":""}]}]},{"displayName":"Location","name":"location","type":"string","default":"","description":"The intended venue"},{"displayName":"Recurrence Rule","name":"recurrenceRule","type":"string","default":"","description":"A rule to define the repeat pattern of the event (RRULE). (<a href=\"https://icalendar.org/rrule-tool.html\">Rule generator</a>)."},{"displayName":"Organizer","name":"organizerUi","type":"fixedCollection","typeOptions":{"multipleValues":false},"placeholder":"Add Organizer","default":{},"options":[{"displayName":"Organizer","name":"organizerValues","values":[{"displayName":"Name","name":"name","type":"string","default":"","required":true},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","required":true}]}]},{"displayName":"Sequence","name":"sequence","type":"number","default":0,"description":"When sending an update for an event (with the same uid), defines the revision sequence number"},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Confirmed","value":"CONFIRMED"},{"name":"Cancelled","value":"CANCELLED"},{"name":"Tentative","value":"TENTATIVE"}],"default":"CONFIRMED"},{"displayName":"UID","name":"uid","type":"string","default":"","description":"Universally unique ID for the event (will be auto-generated if not specified here). Should be globally unique."},{"displayName":"URL","name":"url","type":"string","default":"","description":"URL associated with event"}]}]


node_type: if
package_name: n8n-nodes-base
display_name: IF
description: Route items to different branches (true/false)
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: If
  description: Documentation for the If node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  tags:
    - if
    - if node
    - If
    - If node
  hide:
    - tags
  ---

  # If

  Use the If node to split a workflow conditionally based on comparison operations.

  ## Add conditions

  Create comparison **Conditions** for your If node.

  - Use the data type dropdown to select the data type and comparison operation type for your condition. For example, to filter for dates after a particular date, select **Date & Time > is after**.
  - The fields and values to enter into the condition change based on the data type and comparison you select. Refer to [Available data type comparisons](#available-data-type-comparisons) for a full list of all comparisons by data type.

  Select **Add condition** to create more conditions.

  ### Combining conditions

  You can choose to keep data:

  * When it meets all conditions: Create two or more conditions and select **AND** in the dropdown between them.
  * When it meets any of the conditions: Create two or more conditions and select **OR** in the dropdown between them.

  ## Templates and examples

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

  ## Branch execution with If and Merge nodes

  --8<-- "_snippets/integrations/builtin/core-nodes/merge/if-merge-branch-execution.md"

  ## Related resources

  Refer to [Splitting with conditionals](/flow-logic/splitting.md) for more information on using conditionals to create complex logic in n8n.

  If you need more than two conditional outputs, use the [Switch node](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md).

  --8<-- "_snippets/integrations/builtin/core-nodes/data-types.md"

properties_schema:
  [{"displayName":"Conditions","name":"conditions","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true,"sortable":true},"description":"The type of values to compare","default":{},"options":[{"name":"boolean","displayName":"Boolean","values":[{"displayName":"Value 1","name":"value1","type":"boolean","default":false,"description":"The value to compare with the second one"},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"Equal","value":"equal"},{"name":"Not Equal","value":"notEqual"}],"default":"equal","description":"Operation to decide where the the data should be mapped to"},{"displayName":"Value 2","name":"value2","type":"boolean","default":false,"description":"The value to compare with the first one"}]},{"name":"dateTime","displayName":"Date & Time","values":[{"displayName":"Value 1","name":"value1","type":"dateTime","default":"","description":"The value to compare with the second one"},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"Occurred After","value":"after"},{"name":"Occurred Before","value":"before"}],"default":"after","description":"Operation to decide where the the data should be mapped to"},{"displayName":"Value 2","name":"value2","type":"dateTime","default":"","description":"The value to compare with the first one"}]},{"name":"number","displayName":"Number","values":[{"displayName":"Value 1","name":"value1","type":"number","default":0,"description":"The value to compare with the second one"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Smaller","value":"smaller"},{"name":"Smaller or Equal","value":"smallerEqual"},{"name":"Equal","value":"equal"},{"name":"Not Equal","value":"notEqual"},{"name":"Larger","value":"larger"},{"name":"Larger or Equal","value":"largerEqual"},{"name":"Is Empty","value":"isEmpty"},{"name":"Is Not Empty","value":"isNotEmpty"}],"default":"smaller","description":"Operation to decide where the the data should be mapped to"},{"displayName":"Value 2","name":"value2","type":"number","displayOptions":{"hide":{"operation":["isEmpty","isNotEmpty"]}},"default":0,"description":"The value to compare with the first one"}]},{"name":"string","displayName":"String","values":[{"displayName":"Value 1","name":"value1","type":"string","default":"","description":"The value to compare with the second one"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Contains","value":"contains"},{"name":"Not Contains","value":"notContains"},{"name":"Ends With","value":"endsWith"},{"name":"Not Ends With","value":"notEndsWith"},{"name":"Equal","value":"equal"},{"name":"Not Equal","value":"notEqual"},{"name":"Regex Match","value":"regex"},{"name":"Regex Not Match","value":"notRegex"},{"name":"Starts With","value":"startsWith"},{"name":"Not Starts With","value":"notStartsWith"},{"name":"Is Empty","value":"isEmpty"},{"name":"Is Not Empty","value":"isNotEmpty"}],"default":"equal","description":"Operation to decide where the the data should be mapped to"},{"displayName":"Value 2","name":"value2","type":"string","displayOptions":{"hide":{"operation":["isEmpty","isNotEmpty","regex","notRegex"]}},"default":"","description":"The value to compare with the first one"},{"displayName":"Regex","name":"value2","type":"string","displayOptions":{"show":{"operation":["regex","notRegex"]}},"default":"","placeholder":"/text/i","description":"The regex which has to match"}]}]},{"displayName":"Combine","name":"combineOperation","type":"options","options":[{"name":"ALL","description":"Only if all conditions are met it goes into \"true\" branch","value":"all"},{"name":"ANY","description":"If any of the conditions is met it goes into \"true\" branch","value":"any"}],"default":"all","description":"If multiple rules got set this settings decides if it is true as soon as ANY condition matches or only if ALL get meet"}]


node_type: intercom
package_name: n8n-nodes-base
display_name: Intercom
description: Consume Intercom API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"intercomApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Intercom node documentation
  description: Learn how to use the Intercom node in n8n. Follow technical documentation to integrate Intercom node into your workflows.
  contentType: [integration, reference]
  ---

  # Intercom node

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

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

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

  ## Operations

  * Company
      * Create a new company
      * Get data of a company
      * Get data of all companies
      * Update a company
      * List company's users
  * Lead
      * Create a new lead
      * Delete a lead
      * Get data of a lead
      * Get data of all leads
      * Update new lead
  * User
      * Create a new user
      * Delete a user
      * Get data of a user
      * Get data of 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, 'intercom') ]]

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Company","value":"company","description":"Companies allow you to represent commercial organizations using your product"},{"name":"Lead","value":"lead","description":"Leads are useful for representing logged-out users of your application"},{"name":"User","value":"user","description":"The Users resource is the primary way of interacting with Intercom"}],"default":"user"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["lead"]}},"options":[{"name":"Create","value":"create","description":"Create a new lead","action":"Create a lead"},{"name":"Delete","value":"delete","description":"Delete a lead","action":"Delete a lead"},{"name":"Get","value":"get","description":"Get data of a lead","action":"Get a lead"},{"name":"Get Many","value":"getAll","description":"Get data of many leads","action":"Get many leads"},{"name":"Update","value":"update","description":"Update new lead","action":"Update a lead"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Create","value":"create","description":"Create a new user","action":"Create a user"},{"name":"Delete","value":"delete","description":"Delete a user","action":"Delete a user"},{"name":"Get","value":"get","description":"Get data of a user","action":"Get a user"},{"name":"Get Many","value":"getAll","description":"Get data of many users","action":"Get many users"},{"name":"Update","value":"update","description":"Update a user","action":"Update a user"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["company"]}},"options":[{"name":"Create","value":"create","description":"Create a new company","action":"Create a company"},{"name":"Get","value":"get","description":"Get data of a company","action":"Get a company"},{"name":"Get Many","value":"getAll","description":"Get data of many companies","action":"Get many companies"},{"name":"Update","value":"update","description":"Update a company","action":"Update a company"},{"name":"Users","value":"users","description":"List company's users","action":"List users of a company"}],"default":"create"},{"displayName":"ID","name":"id","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["delete"]}},"default":"","description":"The Intercom defined ID representing the Lead"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["user"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"options":[{"displayName":"Company ID","name":"company_id","type":"string","default":"","description":"Company ID representing the user"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The email address of the user"},{"displayName":"Segment ID","name":"segment_id","type":"string","default":"","description":"Segment representing the user"},{"displayName":"Tag ID","name":"tag_id","type":"string","default":"","description":"Tag representing the user"}]},{"displayName":"Select By","name":"selectBy","type":"options","displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"options":[{"name":"ID","value":"id","default":"","description":"The Intercom defined ID representing the Lead"},{"name":"User ID","value":"userId","default":"","description":"Automatically generated identifier for the Lead"}],"default":"","description":"The property to select the user by"},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"description":"View by value"},{"displayName":"Update By","name":"updateBy","type":"options","displayOptions":{"show":{"resource":["user"],"operation":["update"]}},"options":[{"name":"ID","value":"id","description":"The Intercom defined ID representing the user"},{"name":"Email","value":"email","description":"The email address of user"},{"name":"User ID","value":"userId","description":"Automatically generated identifier for the user"}],"default":"id","description":"The property via which to query the user"},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["update"]}},"description":"Value of the property to identify the user to update"},{"displayName":"Identifier Type","name":"identifierType","type":"options","displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"options":[{"name":"User ID","value":"userId","description":"A unique string identifier for the user. It is required on creation if an email is not supplied."},{"name":"Email","value":"email","description":"The user's email address. It is required on creation if a user_id is not supplied."}],"default":"","description":"Unique string identifier"},{"displayName":"Value","name":"idValue","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"description":"Unique string identifier value"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["create","update"],"resource":["user"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create","update"],"resource":["user"]}},"options":[{"displayName":"Avatar","name":"avatar","type":"string","default":"","description":"An avatar image URL. note: the image URL needs to be https."},{"displayName":"Company Names or IDs","name":"companies","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getCompanies"},"default":[],"description":"Identifies the companies this user belongs to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Email","name":"email","displayOptions":{"show":{"/operation":["update"],"/resource":["user"]},"hide":{"/updateBy":["email"]}},"type":"string","placeholder":"name@email.com","default":"","description":"Email of the user"},{"displayName":"Name","name":"name","type":"string","default":"","placeholder":"","description":"Name of the user"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The phone number of the user"},{"displayName":"Session Count","name":"sessionCount","type":"number","default":false,"options":[],"description":"How many sessions the user has recorded"},{"displayName":"User ID","name":"userId","displayOptions":{"show":{"/operation":["update"],"/resource":["user"]},"hide":{"/updateBy":["email","userId"]}},"type":"string","default":"","description":"Email of the user"},{"displayName":"Unsubscribed From Emails","name":"unsubscribedFromEmails","type":"boolean","default":false,"placeholder":"","description":"Whether the user is unsubscribed from emails"},{"displayName":"Update Last Request At","name":"updateLastRequestAt","type":"boolean","default":false,"options":[],"description":"Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC"},{"displayName":"UTM Campaign","name":"utmCampaign","type":"string","default":"","description":"Identifies a specific product promotion or strategic campaign"},{"displayName":"UTM Content","name":"utmContent","type":"string","default":"","description":"Identifies what specifically was clicked to bring the user to the site"},{"displayName":"UTM Medium","name":"utmMedium","type":"string","default":"","description":"Identifies what type of link was used"},{"displayName":"UTM Source","name":"utmSource","type":"string","default":"","description":"An avatar image URL. note: the image URL needs to be https."},{"displayName":"UTM Term","name":"utmTerm","type":"string","default":"","description":"Identifies search terms"}]},{"displayName":"Custom Attributes","name":"customAttributesJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["user"],"operation":["create","update"],"jsonParameters":[true]}},"default":"","description":"A hash of key/value pairs to represent custom data you want to attribute to a user"},{"displayName":"Custom Attributes","name":"customAttributesUi","type":"fixedCollection","default":{},"placeholder":"Add Attribute","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["user"],"operation":["create","update"],"jsonParameters":[false]}},"options":[{"name":"customAttributesValues","displayName":"Attributes","values":[{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}],"description":"A hash of key/value pairs to represent custom data you want to attribute to a user"},{"displayName":"Delete By","name":"deleteBy","type":"options","displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}},"options":[{"name":"ID","value":"id","description":"The Intercom defined ID representing the Lead"},{"name":"User ID","value":"userId","description":"Automatically generated identifier for the Lead"}],"default":""},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}},"description":"Delete by value"},{"displayName":"Select By","name":"selectBy","type":"options","displayOptions":{"show":{"resource":["lead"],"operation":["get"]}},"options":[{"name":"Email","value":"email","description":"Email representing the Lead"},{"name":"ID","value":"id","description":"The Intercom defined ID representing the Lead"},{"name":"User ID","value":"userId","description":"Automatically generated identifier for the Lead"},{"name":"Phone","value":"phone","description":"Phone representing the Lead"}],"default":"","description":"The property to select the lead by"},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["get"]}},"description":"View by value"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["lead"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["lead"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["getAll"]}},"options":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The email address of the lead"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The phone number of the lead"}]},{"displayName":"Update By","name":"updateBy","type":"options","displayOptions":{"show":{"resource":["lead"],"operation":["update"]}},"options":[{"name":"User ID","value":"userId","description":"Automatically generated identifier for the Lead"},{"name":"ID","value":"id","description":"The Intercom defined ID representing the Lead"}],"default":"id","description":"The property via which to query the lead"},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["update"]}},"description":"Value of the property to identify the lead to update"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["create"]}},"description":"The email of the user"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["create","update"],"resource":["lead"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create","update"],"resource":["lead"]}},"options":[{"displayName":"Avatar","name":"avatar","type":"string","default":"","description":"An avatar image URL. note: the image URL needs to be https."},{"displayName":"Company Names or IDs","name":"companies","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getCompanies"},"default":[],"description":"Identifies the companies this user belongs to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","displayOptions":{"show":{"/resource":["lead"],"/operation":["update"]}},"description":"The email of the user"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the user"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The phone number of the user"},{"displayName":"Unsubscribed From Emails","name":"unsubscribedFromEmails","type":"boolean","default":false,"description":"Whether the Lead is unsubscribed from emails"},{"displayName":"Update Last Request At","name":"updateLastRequestAt","type":"boolean","default":false,"description":"Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC. default value if not sent is false."},{"displayName":"UTM Campaign","name":"utmCampaign","type":"string","default":"","description":"Identifies a specific product promotion or strategic campaign"},{"displayName":"UTM Content","name":"utmContent","type":"string","default":"","description":"Identifies what specifically was clicked to bring the user to the site"},{"displayName":"UTM Medium","name":"utmMedium","type":"string","default":"","description":"Identifies what type of link was used"},{"displayName":"UTM Source","name":"utmSource","type":"string","default":"","description":"An avatar image URL. note: the image URL needs to be https."},{"displayName":"UTM Term","name":"utmTerm","type":"string","default":"","description":"Identifies search terms"}]},{"displayName":"Custom Attributes","name":"customAttributesJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["lead"],"operation":["create","update"],"jsonParameters":[true]}},"default":"","description":"A hash of key/value pairs to represent custom data you want to attribute to a user"},{"displayName":"Custom Attributes","name":"customAttributesUi","type":"fixedCollection","default":{},"placeholder":"Add Attribute","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["lead"],"operation":["create","update"],"jsonParameters":[false]}},"options":[{"name":"customAttributesValues","displayName":"Attributes","values":[{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}],"description":"A hash of key/value pairs to represent custom data you want to attribute to a user"},{"displayName":"List By","name":"listBy","type":"options","displayOptions":{"show":{"resource":["company"],"operation":["users"]}},"options":[{"name":"ID","value":"id","description":"The Intercom defined ID representing the company"},{"name":"Company ID","value":"companyId","description":"The company_id you have given to the company"}],"default":""},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["company"],"operation":["users"]}},"description":"View by value"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["users"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["company"],"operation":["users"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["company"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["getAll"]}},"options":[{"displayName":"Segment ID","name":"segment_id","type":"string","default":"","description":"Segment representing the Lead"},{"displayName":"Tag ID","name":"tag_id","type":"string","default":"","description":"Tag representing the Lead"}]},{"displayName":"Select By","name":"selectBy","type":"options","displayOptions":{"show":{"resource":["company"],"operation":["get"]}},"options":[{"name":"Company ID","value":"companyId","description":"The company_id you have given to the company"},{"name":"ID","value":"id","description":"The Intercom defined ID representing the company"},{"name":"Name","value":"name","description":"The name of the company"}],"default":"","description":"What property to use to query the company"},{"displayName":"Value","name":"value","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["company"],"operation":["get"]}},"description":"View by value"},{"displayName":"Company ID","name":"companyId","type":"string","default":"","displayOptions":{"show":{"resource":["company"],"operation":["create","update"]}},"description":"The company ID you have defined for the company"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["create","update"],"resource":["company"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create","update"],"resource":["company"]}},"options":[{"displayName":"Industry","name":"industry","type":"string","default":"","description":"The industry that this company operates in"},{"displayName":"Monthly Spend","name":"monthlySpend","type":"string","default":"","description":"The phone number of the user"},{"displayName":"Name","name":"name","type":"string","default":"","placeholder":"","description":"Name of the user"},{"displayName":"Plan","name":"plan","type":"string","default":"","placeholder":"","description":"The name of the plan you have associated with the company"},{"displayName":"Size","name":"size","type":"number","default":"","description":"The number of employees in this company"},{"displayName":"Website","name":"website","type":"string","default":"","description":"The URL for this company's website. Please note that the value specified here is not validated. Accepts any string."}]},{"displayName":"Custom Attributes","name":"customAttributesJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["company"],"operation":["create","update"],"jsonParameters":[true]}},"default":"","description":"A hash of key/value pairs to represent custom data you want to attribute to a user"},{"displayName":"Custom Attributes","name":"customAttributesUi","type":"fixedCollection","default":{},"placeholder":"Add Attribute","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["company"],"operation":["create","update"],"jsonParameters":[false]}},"options":[{"name":"customAttributesValues","displayName":"Attributes","values":[{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}],"description":"A hash of key/value pairs to represent custom data you want to attribute to a user"}]

operations:
  [{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"lead","name":"Lead"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"create","name":"Create","action":"Create a lead","resources":["lead"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a lead","resources":["lead"]},{"type":"operation","operation":"get","name":"Get","action":"Get a lead","resources":["lead"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many leads","resources":["lead"]},{"type":"operation","operation":"update","name":"Update","action":"Update a lead","resources":["lead"]},{"type":"operation","operation":"create","name":"Create","action":"Create a user","resources":["user"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a user","resources":["user"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]},{"type":"operation","operation":"update","name":"Update","action":"Update a user","resources":["user"]},{"type":"operation","operation":"create","name":"Create","action":"Create a company","resources":["company"]},{"type":"operation","operation":"get","name":"Get","action":"Get a company","resources":["company"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many companies","resources":["company"]},{"type":"operation","operation":"update","name":"Update","action":"Update a company","resources":["company"]},{"type":"operation","operation":"users","name":"Users","action":"List users of a company","resources":["company"]}]


node_type: interval
package_name: n8n-nodes-base
display_name: Interval
description: Triggers the workflow in a given interval
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"This workflow will run on the schedule you define here once you <a data-key=\"activate\">activate</a> it.<br><br>For testing, you can also trigger it manually: by going back to the canvas and clicking ‘execute workflow’","name":"notice","type":"notice","default":""},{"displayName":"Interval","name":"interval","type":"number","typeOptions":{"minValue":1},"default":1,"description":"Interval value"},{"displayName":"Unit","name":"unit","type":"options","options":[{"name":"Seconds","value":"seconds"},{"name":"Minutes","value":"minutes"},{"name":"Hours","value":"hours"}],"default":"seconds","description":"Unit of the interval value"}]


node_type: invoiceNinja
package_name: n8n-nodes-base
display_name: Invoice Ninja
description: Consume Invoice Ninja API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"invoiceNinjaApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Invoice Ninja node documentation
  description: Learn how to use the Invoice Ninja node in n8n. Follow technical documentation to integrate Invoice Ninja node into your workflows.
  contentType: [integration, reference]
  ---

  # Invoice Ninja node

  Use the Invoice Ninja node to automate work in Invoice Ninja, and integrate Invoice Ninja with other applications. n8n has built-in support for a wide range of Invoice Ninja features, including creating, updating, deleting, and getting clients, expense, invoice, payments and quotes. 

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

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

  ## Operations

  * Client
      * Create a new client
      * Delete a client
      * Get data of a client
      * Get data of all clients
  * Expense
      * Create a new expense
      * Delete an expense
      * Get data of an expense
      * Get data of all expenses
  * Invoice
      * Create a new invoice
      * Delete a invoice
      * Email an invoice
      * Get data of a invoice
      * Get data of all invoices
  * Payment
      * Create a new payment
      * Delete a payment
      * Get data of a payment
      * Get data of all payments
  * Quote
      * Create a new quote
      * Delete a quote
      * Email an quote
      * Get data of a quote
      * Get data of all quotes
  * Task
      * Create a new task
      * Delete a task
      * Get data of a task
      * Get data of all tasks

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"API Version","name":"apiVersion","type":"options","isNodeSetting":true,"displayOptions":{"show":{"@version":[1]}},"options":[{"name":"Version 4","value":"v4"},{"name":"Version 5","value":"v5"}],"default":"v4"},{"displayName":"API Version","name":"apiVersion","type":"options","isNodeSetting":true,"displayOptions":{"show":{"@version":[2]}},"options":[{"name":"Version 4","value":"v4"},{"name":"Version 5","value":"v5"}],"default":"v5"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Client","value":"client"},{"name":"Expense","value":"expense"},{"name":"Invoice","value":"invoice"},{"name":"Payment","value":"payment"},{"name":"Quote","value":"quote"},{"name":"Task","value":"task"}],"default":"client"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["client"]}},"options":[{"name":"Create","value":"create","description":"Create a new client","action":"Create a client"},{"name":"Delete","value":"delete","description":"Delete a client","action":"Delete a client"},{"name":"Get","value":"get","description":"Get data of a client","action":"Get a client"},{"name":"Get Many","value":"getAll","description":"Get data of many clients","action":"Get many clients"}],"default":"create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["client"]}},"options":[{"displayName":"Client Name","name":"clientName","type":"string","default":""},{"displayName":"ID Number","name":"idNumber","type":"string","default":""},{"displayName":"Private Notes","name":"privateNotes","type":"string","default":""},{"displayName":"VAT Number","name":"vatNumber","type":"string","default":""},{"displayName":"Work Phone","name":"workPhone","type":"string","default":""},{"displayName":"Website","name":"website","type":"string","default":""}]},{"displayName":"Billing Address","name":"billingAddressUi","placeholder":"Add Billing Address","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["client"],"operation":["create"]}},"default":{},"options":[{"name":"billingAddressValue","displayName":"Billing Address","values":[{"displayName":"Street Address","name":"streetAddress","type":"string","default":""},{"displayName":"Apt/Suite","name":"aptSuite","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postalCode","type":"string","default":""},{"displayName":"Country Code Name or ID","name":"countryCode","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCountryCodes"},"default":""}]}]},{"displayName":"Contacts","name":"contactsUi","placeholder":"Add Contact","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["client"],"operation":["create"]}},"default":{},"options":[{"name":"contacstValues","displayName":"Contact","values":[{"displayName":"First Name","name":"firstName","type":"string","default":""},{"displayName":"Last Name","name":"lastName","type":"string","default":""},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""}]}]},{"displayName":"Shipping Address","name":"shippingAddressUi","placeholder":"Add Shipping Address","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["client"],"operation":["create"]}},"default":{},"options":[{"name":"shippingAddressValue","displayName":"Shipping Address","values":[{"displayName":"Street Address","name":"streetAddress","type":"string","default":""},{"displayName":"Apt/Suite","name":"aptSuite","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postalCode","type":"string","default":""},{"displayName":"Country Code Name or ID","name":"countryCode","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCountryCodes"},"default":""}]}]},{"displayName":"Client ID","name":"clientId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["client"],"operation":["delete"]}}},{"displayName":"Client ID","name":"clientId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["client"],"operation":["get"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["client"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Invoices","value":"invoices"}],"default":"invoices"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["client"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["client"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["client"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Invoices","value":"invoices"}],"default":"invoices"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["invoice"]}},"options":[{"name":"Create","value":"create","description":"Create a new invoice","action":"Create an invoice"},{"name":"Delete","value":"delete","description":"Delete a invoice","action":"Delete an invoice"},{"name":"Email","value":"email","description":"Email an invoice","action":"Email an invoice"},{"name":"Get","value":"get","description":"Get data of a invoice","action":"Get an invoice"},{"name":"Get Many","value":"getAll","description":"Get data of many invoices","action":"Get many invoices"}],"default":"create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["invoice"]}},"options":[{"displayName":"Client Name or ID","name":"client","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getClients"},"default":""},{"displayName":"Auto Bill","name":"autoBill","type":"boolean","default":false},{"displayName":"Custom Value 1","name":"customValue1","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Custom Value 2","name":"customValue2","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Discount","name":"discount","type":"string","default":""},{"displayName":"Due Date","name":"dueDate","type":"dateTime","default":""},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Email Invoice","name":"emailInvoice","type":"boolean","default":false},{"displayName":"Invoice Date","name":"invoiceDate","type":"dateTime","default":""},{"displayName":"Invoice Number","name":"invoiceNumber","type":"string","default":""},{"displayName":"Invoice Status","name":"invoiceStatus","type":"options","options":[{"name":"Draft","value":1},{"name":"Sent","value":2}],"default":1},{"displayName":"Is Amount Discount","name":"isAmountDiscount","type":"boolean","default":false},{"displayName":"Paid","name":"paid","type":"number","default":0},{"displayName":"Partial","name":"partial","type":"number","default":0},{"displayName":"Partial Due Date","name":"partialDueDate","type":"dateTime","default":""},{"displayName":"PO Number","name":"poNumber","type":"string","default":""},{"displayName":"Private Notes","name":"privateNotes","type":"string","default":""},{"displayName":"Public Notes","name":"publicNotes","type":"string","default":""},{"displayName":"Tax Name 1","name":"taxName1","type":"string","default":""},{"displayName":"Tax Name 2","name":"taxName2","type":"string","default":""},{"displayName":"Tax Rate 1","name":"taxRate1","type":"number","default":0},{"displayName":"Tax Rate 2","name":"taxRate2","type":"number","default":0}]},{"displayName":"Invoice Items","name":"invoiceItemsUi","placeholder":"Add Invoice Item","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["invoice"],"operation":["create"]}},"default":{},"options":[{"name":"invoiceItemsValues","displayName":"Invoice Item","values":[{"displayName":"Cost","name":"cost","type":"number","default":0},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Service","name":"service","type":"string","default":""},{"displayName":"Hours","name":"hours","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Tax Name 1","name":"taxName1","type":"string","default":""},{"displayName":"Tax Name 2","name":"taxName2","type":"string","default":""},{"displayName":"Tax Rate 1","name":"taxRate1","type":"number","default":0},{"displayName":"Tax Rate 2","name":"taxRate2","type":"number","default":0}]}]},{"displayName":"Invoice ID","name":"invoiceId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["invoice"],"operation":["delete"]}}},{"displayName":"Invoice ID","name":"invoiceId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["invoice"],"operation":["email"]}}},{"displayName":"Invoice ID","name":"invoiceId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["invoice"],"operation":["get"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["invoice"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["invoice"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["invoice"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["invoice"]}},"options":[{"displayName":"Invoice Number","name":"invoiceNumber","type":"string","default":""},{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["task"]}},"options":[{"name":"Create","value":"create","description":"Create a new task","action":"Create a task"},{"name":"Delete","value":"delete","description":"Delete a task","action":"Delete a task"},{"name":"Get","value":"get","description":"Get data of a task","action":"Get a task"},{"name":"Get Many","value":"getAll","description":"Get data of many tasks","action":"Get many tasks"}],"default":"create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["task"]}},"options":[{"displayName":"Client Name or ID","name":"client","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getClients"},"default":""},{"displayName":"Custom Value 1","name":"customValue1","type":"string","default":""},{"displayName":"Custom Value 2","name":"customValue2","type":"string","default":""},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Project Name or ID","name":"project","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getProjects"},"default":""}]},{"displayName":"Time Logs","name":"timeLogsUi","placeholder":"Add Time Log","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"default":{},"options":[{"name":"timeLogsValues","displayName":"Time Log","values":[{"displayName":"Start Date","name":"startDate","type":"dateTime","default":""},{"displayName":"End Date","name":"endDate","type":"dateTime","default":""},{"displayName":"Duration (Hours)","name":"duration","type":"number","typeOptions":{"minValue":0},"default":0}]}]},{"displayName":"Task ID","name":"taskId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["delete"]}}},{"displayName":"Task ID","name":"taskId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["get"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["task"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["task"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["task"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["payment"]}},"options":[{"name":"Create","value":"create","description":"Create a new payment","action":"Create a payment"},{"name":"Delete","value":"delete","description":"Delete a payment","action":"Delete a payment"},{"name":"Get","value":"get","description":"Get data of a payment","action":"Get a payment"},{"name":"Get Many","value":"getAll","description":"Get data of many payments","action":"Get many payments"}],"default":"create"},{"displayName":"Invoice Name or ID","name":"invoice","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getInvoices"},"displayOptions":{"show":{"operation":["create"],"resource":["payment"]}},"default":""},{"displayName":"Amount","name":"amount","type":"number","displayOptions":{"show":{"operation":["create"],"resource":["payment"]}},"typeOptions":{"minValue":0},"default":0},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["payment"]}},"options":[{"displayName":"Payment Type","name":"paymentType","type":"options","options":[{"name":"ACH","value":5},{"name":"Alipay","value":28},{"name":"American Express","value":8},{"name":"Apply Credit","value":1},{"name":"Bank Transfer","value":2},{"name":"Bitcoin","value":32},{"name":"Carte Blanche","value":17},{"name":"Cash","value":3},{"name":"Check","value":16},{"name":"Credit Card Other","value":13},{"name":"Debit","value":4},{"name":"Diners Card","value":10},{"name":"Discover Card","value":9},{"name":"EuroCard","value":11},{"name":"GoCardless","value":31},{"name":"Google Wallet","value":15},{"name":"iZettle","value":24},{"name":"JCB","value":19},{"name":"Laser","value":20},{"name":"Maestro","value":21},{"name":"MasterCard","value":7},{"name":"Money Order","value":27},{"name":"Nova","value":12},{"name":"Paypal","value":14},{"name":"SEPA","value":30},{"name":"Sofort","value":29},{"name":"Solo","value":22},{"name":"Swich","value":23},{"name":"Swish","value":25},{"name":"UnionPay","value":18},{"name":"Venmo","value":26},{"name":"Visa Card","value":6}],"default":1},{"displayName":"Transfer Reference","name":"transferReference","type":"string","default":""},{"displayName":"Private Notes","name":"privateNotes","type":"string","default":""}]},{"displayName":"Payment ID","name":"paymentId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["payment"],"operation":["delete"]}}},{"displayName":"Payment ID","name":"paymentId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["payment"],"operation":["get"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["payment"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["payment"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["payment"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["payment"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["expense"]}},"options":[{"name":"Create","value":"create","description":"Create a new expense","action":"Create an expense"},{"name":"Delete","value":"delete","description":"Delete an expense","action":"Delete an expense"},{"name":"Get","value":"get","description":"Get data of an expense","action":"Get an expense"},{"name":"Get Many","value":"getAll","description":"Get data of many expenses","action":"Get many expenses"}],"default":"create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["expense"]}},"options":[{"displayName":"Amount","name":"amount","type":"number","default":0},{"displayName":"Billable","name":"billable","type":"boolean","default":false},{"displayName":"Client Name or ID","name":"client","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getClients"},"default":""},{"displayName":"Custom Value 1","name":"customValue1","type":"string","default":""},{"displayName":"Custom Value 2","name":"customValue2","type":"string","default":""},{"displayName":"Category Name or ID","name":"category","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getExpenseCategories"},"default":""},{"displayName":"Expense Date","name":"expenseDate","type":"dateTime","default":""},{"displayName":"Payment Date","name":"paymentDate","type":"dateTime","default":""},{"displayName":"Payment Type","name":"paymentType","type":"options","options":[{"name":"ACH","value":5},{"name":"Alipay","value":28},{"name":"American Express","value":8},{"name":"Apply Credit","value":1},{"name":"Bank Transfer","value":2},{"name":"Bitcoin","value":32},{"name":"Carte Blanche","value":17},{"name":"Cash","value":3},{"name":"Check","value":16},{"name":"Credit Card Other","value":13},{"name":"Debit","value":4},{"name":"Diners Card","value":10},{"name":"Discover Card","value":9},{"name":"EuroCard","value":11},{"name":"GoCardless","value":31},{"name":"Google Wallet","value":15},{"name":"iZettle","value":24},{"name":"JCB","value":19},{"name":"Laser","value":20},{"name":"Maestro","value":21},{"name":"MasterCard","value":7},{"name":"Money Order","value":27},{"name":"Nova","value":12},{"name":"Paypal","value":14},{"name":"SEPA","value":30},{"name":"Sofort","value":29},{"name":"Solo","value":22},{"name":"Swich","value":23},{"name":"Swish","value":25},{"name":"UnionPay","value":18},{"name":"Venmo","value":26},{"name":"Visa Card","value":6}],"default":1},{"displayName":"Private Notes","name":"privateNotes","type":"string","default":""},{"displayName":"Public Notes","name":"publicNotes","type":"string","default":""},{"displayName":"Tax Name 1","name":"taxName1","type":"string","default":""},{"displayName":"Tax Name 2","name":"taxName2","type":"string","default":""},{"displayName":"Tax Rate 1","name":"taxRate1","type":"number","default":0},{"displayName":"Tax Rate 2","name":"taxRate2","type":"number","default":0},{"displayName":"Transaction Reference","name":"transactionReference","type":"string","default":""},{"displayName":"Vendor Name or ID","name":"vendor","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getVendors"},"default":""}]},{"displayName":"Expense ID","name":"expenseId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["expense"],"operation":["delete"]}}},{"displayName":"Expense ID","name":"expenseId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["expense"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["expense"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["expense"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["quote"]}},"options":[{"name":"Create","value":"create","description":"Create a new quote","action":"Create a quote"},{"name":"Delete","value":"delete","description":"Delete a quote","action":"Delete a quote"},{"name":"Email","value":"email","description":"Email an quote","action":"Email a quote"},{"name":"Get","value":"get","description":"Get data of a quote","action":"Get a quote"},{"name":"Get Many","value":"getAll","description":"Get data of many quotes","action":"Get many quotes"}],"default":"create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["quote"]}},"options":[{"displayName":"Client Name or ID","name":"client","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getClients"},"default":""},{"displayName":"Auto Bill","name":"autoBill","type":"boolean","default":false},{"displayName":"Custom Value 1","name":"customValue1","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Custom Value 2","name":"customValue2","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Discount","name":"discount","type":"string","default":""},{"displayName":"Due Date","name":"dueDate","type":"dateTime","default":""},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Email Quote","name":"emailQuote","type":"boolean","default":false},{"displayName":"Quote Date","name":"quoteDate","type":"dateTime","default":""},{"displayName":"Quote Number","name":"quoteNumber","type":"string","default":""},{"displayName":"Quote Status","name":"quoteStatus","type":"options","options":[{"name":"Draft","value":1},{"name":"Sent","value":2}],"default":1},{"displayName":"Is Amount Discount","name":"isAmountDiscount","type":"boolean","default":false},{"displayName":"Paid","name":"paid","type":"number","default":0},{"displayName":"Partial","name":"partial","type":"number","default":0},{"displayName":"Partial Due Date","name":"partialDueDate","type":"dateTime","default":""},{"displayName":"Po Number","name":"poNumber","type":"string","default":""},{"displayName":"Private Notes","name":"privateNotes","type":"string","default":""},{"displayName":"Public Notes","name":"publicNotes","type":"string","default":""},{"displayName":"Tax Name 1","name":"taxName1","type":"string","default":""},{"displayName":"Tax Name 2","name":"taxName2","type":"string","default":""},{"displayName":"Tax Rate 1","name":"taxRate1","type":"number","default":0},{"displayName":"Tax Rate 2","name":"taxRate2","type":"number","default":0}]},{"displayName":"Invoice Items","name":"invoiceItemsUi","placeholder":"Add Invoice Item","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["quote"],"operation":["create"]}},"default":{},"options":[{"name":"invoiceItemsValues","displayName":"Invoice Item","values":[{"displayName":"Cost","name":"cost","type":"number","default":0},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Service","name":"service","type":"string","default":""},{"displayName":"Hours","name":"hours","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Tax Name 1","name":"taxName1","type":"string","default":""},{"displayName":"Tax Name 2","name":"taxName2","type":"string","default":""},{"displayName":"Tax Rate 1","name":"taxRate1","type":"number","default":0},{"displayName":"Tax Rate 2","name":"taxRate2","type":"number","default":0}]}]},{"displayName":"Quote ID","name":"quoteId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["quote"],"operation":["delete"]}}},{"displayName":"Quote ID","name":"quoteId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["quote"],"operation":["email"]}}},{"displayName":"Quote ID","name":"quoteId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["quote"],"operation":["get"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["quote"]}},"options":[{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["quote"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["quote"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":60},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["quote"]}},"options":[{"displayName":"Quote Number","name":"quoteNumber","type":"string","default":""},{"displayName":"Include","name":"include","type":"options","options":[{"name":"Client","value":"client"}],"default":"client"}]}]

operations:
  [{"type":"resource","resource":"client","name":"Client"},{"type":"resource","resource":"expense","name":"Expense"},{"type":"resource","resource":"invoice","name":"Invoice"},{"type":"resource","resource":"payment","name":"Payment"},{"type":"resource","resource":"quote","name":"Quote"},{"type":"resource","resource":"task","name":"Task"},{"type":"operation","operation":"create","name":"Create","action":"Create a client","resources":["client"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a client","resources":["client"]},{"type":"operation","operation":"get","name":"Get","action":"Get a client","resources":["client"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many clients","resources":["client"]},{"type":"operation","operation":"create","name":"Create","action":"Create an invoice","resources":["invoice"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an invoice","resources":["invoice"]},{"type":"operation","operation":"email","name":"Email","action":"Email an invoice","resources":["invoice"]},{"type":"operation","operation":"get","name":"Get","action":"Get an invoice","resources":["invoice"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many invoices","resources":["invoice"]},{"type":"operation","operation":"create","name":"Create","action":"Create a task","resources":["task"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a task","resources":["task"]},{"type":"operation","operation":"get","name":"Get","action":"Get a task","resources":["task"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many tasks","resources":["task"]},{"type":"operation","operation":"create","name":"Create","action":"Create a payment","resources":["payment"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a payment","resources":["payment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a payment","resources":["payment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many payments","resources":["payment"]},{"type":"operation","operation":"create","name":"Create","action":"Create an expense","resources":["expense"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an expense","resources":["expense"]},{"type":"operation","operation":"get","name":"Get","action":"Get an expense","resources":["expense"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many expenses","resources":["expense"]},{"type":"operation","operation":"create","name":"Create","action":"Create a quote","resources":["quote"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a quote","resources":["quote"]},{"type":"operation","operation":"email","name":"Email","action":"Email a quote","resources":["quote"]},{"type":"operation","operation":"get","name":"Get","action":"Get a quote","resources":["quote"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many quotes","resources":["quote"]}]


node_type: invoiceNinjaTrigger
package_name: n8n-nodes-base
display_name: Invoice Ninja Trigger
description: Starts the workflow when Invoice Ninja events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"invoiceNinjaApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Invoice Ninja Trigger node documentation
  description: Learn how to use the Invoice Ninja Trigger node in n8n. Follow technical documentation to integrate Invoice Ninja Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Invoice Ninja Trigger node

  [Invoice Ninja](https://www.invoiceninja.com/){:target=_blank .external-link} is a free open-source online invoicing app for freelancers & businesses. It offers invoicing, payments, expense tracking, & time-tasks.

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

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

properties_schema:
  [{"displayName":"API Version","name":"apiVersion","type":"options","isNodeSetting":true,"displayOptions":{"show":{"@version":[1]}},"options":[{"name":"Version 4","value":"v4"},{"name":"Version 5","value":"v5"}],"default":"v4"},{"displayName":"API Version","name":"apiVersion","type":"options","isNodeSetting":true,"displayOptions":{"show":{"@version":[2]}},"options":[{"name":"Version 4","value":"v4"},{"name":"Version 5","value":"v5"}],"default":"v5"},{"displayName":"Event","name":"event","type":"options","options":[{"name":"Client Created","value":"create_client"},{"name":"Invoice Created","value":"create_invoice"},{"name":"Payment Created","value":"create_payment"},{"name":"Quote Created","value":"create_quote"},{"name":"Vendor Created","value":"create_vendor"}],"default":"","required":true}]


node_type: iterable
package_name: n8n-nodes-base
display_name: Iterable
description: Consume Iterable API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"iterableApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Iterable node documentation
  description: Learn how to use the Iterable node in n8n. Follow technical documentation to integrate Iterable node into your workflows.
  contentType: [integration, reference]
  ---

  # Iterable node

  Use the Iterable node to automate work in Iterable, and integrate Iterable with other applications. n8n has built-in support for a wide range of Iterable features, including creating users, recording the actions performed by the users, and adding and removing users from the list. 

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

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

  ## Operations

  * Event
      * Record the actions a user perform
  * User
      * Create/Update a user
      * Delete a user
      * Get a user
  * User List
      * Add user to list
      * Remove a user from a list

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Event","value":"event"},{"name":"User","value":"user"},{"name":"User List","value":"userList"}],"default":"user"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["event"]}},"options":[{"name":"Track","value":"track","description":"Record the actions a user perform","action":"Track an event"}],"default":"track"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["event"],"operation":["track"]}},"description":"The name of the event to track","default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["track"]}},"options":[{"displayName":"Campaign ID","name":"campaignId","type":"string","default":"","description":"Campaign tied to conversion"},{"displayName":"Created At","name":"createdAt","type":"dateTime","default":"","description":"Time event happened"},{"displayName":"Data Fields","name":"dataFieldsUi","type":"fixedCollection","default":{},"placeholder":"Add Data Field","typeOptions":{"multipleValues":true},"options":[{"name":"dataFieldValues","displayName":"Data Field","values":[{"displayName":"Key","name":"key","type":"string","default":"","description":"The end event specified key of the event defined data"},{"displayName":"Value","name":"value","type":"string","default":"","description":"The end event specified value of the event defined data"}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Either email or userId must be passed in to identify the user. If both are passed in, email takes precedence."},{"displayName":"ID","name":"id","type":"string","default":"","description":"Optional event ID. If an event exists with that ID, the event will be updated. If none is specified, a new ID will automatically be generated and returned."},{"displayName":"Template ID","name":"templateId","type":"string","default":""},{"displayName":"User ID","name":"userId","type":"string","default":"","description":"userId that was passed into the updateUser call"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Create or Update","value":"upsert","description":"Create a new user, or update the current one if it already exists (upsert)","action":"Create or update 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"}],"default":"upsert"},{"displayName":"Identifier","name":"identifier","type":"options","required":true,"options":[{"name":"Email","value":"email"},{"name":"User ID","value":"userId"}],"displayOptions":{"show":{"resource":["user"],"operation":["upsert"]}},"default":"","description":"Identifier to be used"},{"displayName":"Value","name":"value","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["upsert"]}},"default":""},{"displayName":"Create If Doesn't Exist","name":"preferUserId","type":"boolean","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["upsert"],"identifier":["userId"]}},"default":true,"description":"Whether to create a new user if the idetifier does not exist"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["upsert"]}},"options":[{"displayName":"Data Fields","name":"dataFieldsUi","type":"fixedCollection","default":{},"placeholder":"Add Data Field","typeOptions":{"multipleValues":true},"options":[{"name":"dataFieldValues","displayName":"Data Field","values":[{"displayName":"Key","name":"key","type":"string","default":"","description":"The end user specified key of the user defined data"},{"displayName":"Value","name":"value","type":"string","default":"","description":"The end user specified value of the user defined data"}]}]},{"displayName":"Merge Nested Objects","name":"mergeNestedObjects","type":"boolean","default":false,"description":"Whether to merge top level objects instead of overwriting (default: false), e.g. if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}}, the resulting profile: {mySettings:{mobile:true,email:true}}"}]},{"displayName":"By","name":"by","type":"options","required":true,"options":[{"name":"Email","value":"email"},{"name":"User ID","value":"userId"}],"displayOptions":{"show":{"resource":["user"],"operation":["delete"]}},"default":"email","description":"Identifier to be used"},{"displayName":"User ID","name":"userId","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["delete"],"by":["userId"]}},"default":"","description":"Unique identifier for a particular user"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["delete"],"by":["email"]}},"default":"","description":"Email for a particular user"},{"displayName":"By","name":"by","type":"options","required":true,"options":[{"name":"Email","value":"email"},{"name":"User ID","value":"userId"}],"displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"default":"email","description":"Identifier to be used"},{"displayName":"User ID","name":"userId","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["get"],"by":["userId"]}},"default":"","description":"Unique identifier for a particular user"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["get"],"by":["email"]}},"default":"","description":"Email for a particular user"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["userList"]}},"options":[{"name":"Add","value":"add","description":"Add user to list","action":"Add a user to a list"},{"name":"Remove","value":"remove","description":"Remove a user from a list","action":"Remove a user from a list"}],"default":"add"},{"displayName":"List Name or ID","name":"listId","type":"options","typeOptions":{"loadOptionsMethod":"getLists"},"required":true,"displayOptions":{"show":{"resource":["userList"],"operation":["add"]}},"default":"","description":"Identifier to be used. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Identifier","name":"identifier","type":"options","required":true,"options":[{"name":"Email","value":"email"},{"name":"User ID","value":"userId"}],"displayOptions":{"show":{"resource":["userList"],"operation":["add"]}},"default":"","description":"Identifier to be used"},{"displayName":"Value","name":"value","type":"string","required":true,"displayOptions":{"show":{"resource":["userList"],"operation":["add"]}},"default":""},{"displayName":"List Name or ID","name":"listId","type":"options","typeOptions":{"loadOptionsMethod":"getLists"},"required":true,"displayOptions":{"show":{"resource":["userList"],"operation":["remove"]}},"default":"","description":"Identifier to be used. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Identifier","name":"identifier","type":"options","required":true,"options":[{"name":"Email","value":"email"},{"name":"User ID","value":"userId"}],"displayOptions":{"show":{"resource":["userList"],"operation":["remove"]}},"default":"","description":"Identifier to be used"},{"displayName":"Value","name":"value","type":"string","required":true,"displayOptions":{"show":{"resource":["userList"],"operation":["remove"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["userList"],"operation":["remove"]}},"options":[{"displayName":"Campaign ID","name":"campaignId","type":"number","default":0,"description":"Attribute unsubscribe to a campaign"},{"displayName":"Channel Unsubscribe","name":"channelUnsubscribe","type":"boolean","default":false,"description":"Whether to unsubscribe email from list's associated channel - essentially a global unsubscribe"}]}]

operations:
  [{"type":"resource","resource":"event","name":"Event"},{"type":"resource","resource":"user","name":"User"},{"type":"resource","resource":"userList","name":"User List"},{"type":"operation","operation":"track","name":"Track","action":"Track an event","resources":["event"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a user","resources":["user"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a user","resources":["user"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]},{"type":"operation","operation":"add","name":"Add","action":"Add a user to a list","resources":["userList"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a user from a list","resources":["userList"]}]


node_type: jenkins
package_name: n8n-nodes-base
display_name: Jenkins
description: Consume Jenkins API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"jenkinsApi","required":true,"testedBy":"jenkinApiCredentialTest"}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Jenkins node documentation
  description: Learn how to use the Jenkins node in n8n. Follow technical documentation to integrate Jenkins node into your workflows.
  contentType: [integration, reference]
  ---

  # Jenkins node

  Use the Jenkins node to automate work in Jenkins, and integrate Jenkins with other applications. n8n has built-in support for a wide range of Jenkins features, including listing builds, managing instances, and creating and copying jobs. 

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

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

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

  ## Operations

  * Build
      * List Builds
  * Instance
      * Cancel quiet down state
      * Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown
      * Restart Jenkins immediately on environments where it's possible
      * Restart Jenkins once no jobs are running on environments where it's possible
      * Shutdown once no jobs are running
      * Shutdown Jenkins immediately
  * Job
      * Copy a specific job
      * Create a new job
      * Trigger a specific job
      * Trigger a specific job

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","options":[{"name":"Build","value":"build"},{"name":"Instance","value":"instance"},{"name":"Job","value":"job"}],"default":"job","noDataExpression":true},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["job"]}},"options":[{"name":"Copy","value":"copy","description":"Copy a specific job","action":"Copy a job"},{"name":"Create","value":"create","description":"Create a new job","action":"Create a job"},{"name":"Trigger","value":"trigger","description":"Trigger a specific job","action":"Trigger a job"},{"name":"Trigger with Parameters","value":"triggerParams","description":"Trigger a specific job","action":"Trigger a job with parameters"}],"default":"trigger","description":"Possible operations","noDataExpression":true},{"displayName":"Make sure the job is setup to support triggering with parameters. <a href=\"https://wiki.jenkins.io/display/JENKINS/Parameterized+Build\" target=\"_blank\">More info</a>","name":"triggerParamsNotice","type":"notice","displayOptions":{"show":{"resource":["job"],"operation":["triggerParams"]}},"default":""},{"displayName":"Job Name or ID","name":"job","type":"options","typeOptions":{"loadOptionsMethod":"getJobs"},"displayOptions":{"show":{"resource":["job"],"operation":["trigger","triggerParams","copy"]}},"required":true,"default":"","description":"Name of the job. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Parameters","name":"param","type":"fixedCollection","placeholder":"Add Parameter","displayOptions":{"show":{"resource":["job"],"operation":["triggerParams"]}},"required":true,"default":{},"typeOptions":{"multipleValues":true},"options":[{"name":"params","displayName":"Parameters","values":[{"displayName":"Name or ID","name":"name","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getJobParameters","loadOptionsDependsOn":["job"]},"default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}],"description":"Parameters for Jenkins job"},{"displayName":"New Job Name","name":"newJob","type":"string","displayOptions":{"show":{"resource":["job"],"operation":["copy","create"]}},"required":true,"default":"","description":"Name of the new Jenkins job"},{"displayName":"XML","name":"xml","type":"string","displayOptions":{"show":{"resource":["job"],"operation":["create"]}},"required":true,"default":"","description":"XML of Jenkins config"},{"displayName":"To get the XML of an existing job, add ‘config.xml’ to the end of the job URL","name":"createNotice","type":"notice","default":"","displayOptions":{"show":{"resource":["job"],"operation":["create"]}}},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["instance"]}},"options":[{"name":"Cancel Quiet Down","value":"cancelQuietDown","description":"Cancel quiet down state","action":"Cancel Quiet Down an instance"},{"name":"Quiet Down","value":"quietDown","description":"Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown","action":"Quiet Down an instance"},{"name":"Restart","value":"restart","description":"Restart Jenkins immediately on environments where it is possible","action":"Restart an instance"},{"name":"Safely Restart","value":"safeRestart","description":"Restart Jenkins once no jobs are running on environments where it is possible","action":"Safely Restart an instance"},{"name":"Safely Shutdown","value":"safeExit","description":"Shutdown once no jobs are running","action":"Safely Shutdown an instance"},{"name":"Shutdown","value":"exit","description":"Shutdown Jenkins immediately","action":"Shutdown an instance"}],"default":"safeRestart","description":"Jenkins instance operations","noDataExpression":true},{"displayName":"Reason","name":"reason","type":"string","displayOptions":{"show":{"resource":["instance"],"operation":["quietDown"]}},"default":"","description":"Freeform reason for quiet down mode"},{"displayName":"Instance operation can shutdown Jenkins instance and make it unresponsive. Some commands may not be available depending on instance implementation.","name":"instanceNotice","type":"notice","default":"","displayOptions":{"show":{"resource":["instance"]}}},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["build"]}},"options":[{"name":"Get Many","value":"getAll","description":"List Builds","action":"Get many builds"}],"default":"getAll","noDataExpression":true},{"displayName":"Job Name or ID","name":"job","type":"options","typeOptions":{"loadOptionsMethod":"getJobs"},"displayOptions":{"show":{"resource":["build"],"operation":["getAll"]}},"required":true,"default":"","description":"Name of the job. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"displayOptions":{"show":{"resource":["build"],"operation":["getAll"]}},"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":50,"typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["build"],"operation":["getAll"],"returnAll":[false]}},"description":"Max number of results to return"}]

operations:
  [{"type":"resource","resource":"build","name":"Build"},{"type":"resource","resource":"instance","name":"Instance"},{"type":"resource","resource":"job","name":"Job"},{"type":"operation","operation":"copy","name":"Copy","action":"Copy a job","resources":["job"]},{"type":"operation","operation":"create","name":"Create","action":"Create a job","resources":["job"]},{"type":"operation","operation":"trigger","name":"Trigger","action":"Trigger a job","resources":["job"]},{"type":"operation","operation":"triggerParams","name":"Trigger with Parameters","action":"Trigger a job with parameters","resources":["job"]},{"type":"operation","operation":"cancelQuietDown","name":"Cancel Quiet Down","action":"Cancel Quiet Down an instance","resources":["instance"]},{"type":"operation","operation":"quietDown","name":"Quiet Down","action":"Quiet Down an instance","resources":["instance"]},{"type":"operation","operation":"restart","name":"Restart","action":"Restart an instance","resources":["instance"]},{"type":"operation","operation":"safeRestart","name":"Safely Restart","action":"Safely Restart an instance","resources":["instance"]},{"type":"operation","operation":"safeExit","name":"Safely Shutdown","action":"Safely Shutdown an instance","resources":["instance"]},{"type":"operation","operation":"exit","name":"Shutdown","action":"Shutdown an instance","resources":["instance"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many builds","resources":["build"]}]


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

  # Jira Software node

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

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

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

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

  ## Operations

  * Issue
      * Get issue changelog
      * Create a new issue
      * Delete an issue
      * Get an issue
      * Get all issues
      * Create an email notification for an issue and add it to the mail queue
      * Return either all transitions or a transition that can be performed by the user on an issue, based on the issue's status
      * Update an issue
  * Issue Attachment
      * Add attachment to issue
      * Get an attachment
      * Get all attachments
      * Remove an attachment
  * Issue Comment
      * Add comment to issue
      * Get a comment
      * Get all comments
      * Remove a comment
      * Update a comment
  * User
      * Create a new user.
      * Delete a user.
      * Retrieve a user.

  ## Templates and examples

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

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

  ## Related resources

  Refer to the [official JQL documentation](https://www.atlassian.com/software/jira/guides/expand-jira/jql) about Jira Query Language (JQL) to learn more about it.

  ## Fetch issues for a specific project

  The **Get All** operation returns all the issues from Jira. To fetch issues for a particular project, you need to use Jira Query Language (JQL).

  For example, if you want to receive all the issues of a project named `n8n`, you'd do something like this:

  - Select **Get All** from the **Operation** dropdown list.
  - Toggle **Return All** to true.
  - Select **Add Option** and select **JQL**.
  - Enter `project=n8n` in the **JQL** field.

  This query will fetch all the issues in the project named `n8n`. Enter the name of your project instead of `n8n` to fetch all the issues for your project.

properties_schema:
  [{"displayName":"Jira Version","name":"jiraVersion","type":"options","options":[{"name":"Cloud","value":"cloud"},{"name":"Server (Self Hosted)","value":"server"}],"default":"cloud"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Issue","value":"issue","description":"Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask"},{"name":"Issue Attachment","value":"issueAttachment","description":"Add, remove, and get an attachment from an issue"},{"name":"Issue Comment","value":"issueComment","description":"Get, create, update, and delete a comment from an issue"},{"name":"User","value":"user","description":"Get, create and delete a user"}],"default":"issue"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["issue"]}},"options":[{"name":"Changelog","value":"changelog","description":"Get issue changelog","action":"Get an issue changelog"},{"name":"Create","value":"create","description":"Create a new issue","action":"Create an issue"},{"name":"Delete","value":"delete","description":"Delete an issue","action":"Delete an issue"},{"name":"Get","value":"get","description":"Get an issue","action":"Get an issue"},{"name":"Get Many","value":"getAll","description":"Get many issues","action":"Get many issues"},{"name":"Notify","value":"notify","description":"Create an email notification for an issue and add it to the mail queue","action":"Create an email notification for an issue"},{"name":"Status","value":"transitions","description":"Return either all transitions or a transition that can be performed by the user on an issue, based on the issue's status","action":"Get the status of an issue"},{"name":"Update","value":"update","description":"Update an issue","action":"Update an issue"}],"default":"create"},{"displayName":"Project","name":"project","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"modes":[{"displayName":"Project","name":"list","type":"list","placeholder":"Select a Project...","typeOptions":{"searchListMethod":"getProjects","searchable":true}},{"displayName":"ID","name":"id","type":"string","placeholder":"10000","validation":[{"type":"regex","properties":{"regex":"([0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Project ID"}}],"extractValue":{"type":"regex","regex":"^([0-9]{2,})"}}],"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}}},{"displayName":"Issue Type","name":"issueType","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"modes":[{"displayName":"Issue Type","name":"list","type":"list","placeholder":"Select an Issue Type...","typeOptions":{"searchListMethod":"getIssueTypes"}},{"displayName":"ID","name":"id","type":"string","placeholder":"10000","validation":[{"type":"regex","properties":{"regex":"([0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Issue Type ID"}}],"extractValue":{"type":"regex","regex":"^([0-9]{2,})"}}],"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}}},{"displayName":"Summary","name":"summary","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}},"options":[{"displayName":"Assignee","name":"assignee","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Assignee","name":"list","type":"list","placeholder":"Select an Assignee...","typeOptions":{"searchListMethod":"getUsers","searchable":true}},{"displayName":"ID","name":"id","type":"string","placeholder":"62971ebae540870069668714","validation":[{"type":"regex","properties":{"regex":"([-:a-z0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Assignee ID"}}],"extractValue":{"type":"regex","regex":"^([-:a-z0-9]{2,})"}}]},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Component Names or IDs","name":"componentIds","type":"multiOptions","description":"Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getProjectComponents","loadOptionsDependsOn":["project"]},"default":[]},{"displayName":"Custom Fields","name":"customFieldsUi","type":"fixedCollection","default":{},"placeholder":"Add Custom Field","typeOptions":{"multipleValues":true},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field","name":"fieldId","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Field","name":"list","type":"list","placeholder":"Select a Field...","typeOptions":{"searchListMethod":"getCustomFields"}},{"displayName":"ID","name":"id","type":"string","placeholder":"customfield_10035","validation":[{"type":"regex","properties":{"regex":"(customfield_[0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Field ID"}}],"extractValue":{"type":"regex","regex":"^(customfield_[0-9]{2,})"}}]},{"displayName":"Field Value","name":"fieldValue","type":"string","description":"Value of the field to set","default":""}]}]},{"displayName":"Label Names or IDs","name":"labels","type":"multiOptions","description":"Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getLabels"},"default":[],"displayOptions":{"show":{"/jiraVersion":["cloud"]}}},{"displayName":"Labels","name":"serverLabels","type":"string","default":[],"displayOptions":{"show":{"/jiraVersion":["server"]}},"typeOptions":{"multipleValues":true}},{"displayName":"Parent Issue Key","name":"parentIssueKey","type":"string","default":""},{"displayName":"Priority","name":"priority","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Priority","name":"list","type":"list","placeholder":"Select a Priority...","typeOptions":{"searchListMethod":"getPriorities"}},{"displayName":"ID","name":"id","type":"string","placeholder":"1","validation":[{"type":"regex","properties":{"regex":"([0-9]{1,})[ \t]*","errorMessage":"Not a valid Jira Priority ID"}}],"extractValue":{"type":"regex","regex":"^([0-9]{1,})"}}]},{"displayName":"Reporter","name":"reporter","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Reporter","name":"list","type":"list","placeholder":"Select a Reporter...","typeOptions":{"searchListMethod":"getUsers","searchable":true}},{"displayName":"ID","name":"id","type":"string","placeholder":"62971ebae540870069668714","validation":[{"type":"regex","properties":{"regex":"([-:a-z0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Reporter ID"}}],"extractValue":{"type":"regex","regex":"^([-:a-z0-9]{2,})"}}]},{"displayName":"Update History","name":"updateHistory","type":"boolean","default":false,"description":"Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira"}]},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["update"]}},"default":""},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["update"]}},"options":[{"displayName":"Assignee","name":"assignee","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Assignee","name":"list","type":"list","placeholder":"Select an Assignee...","typeOptions":{"searchListMethod":"getUsers","searchable":true}},{"displayName":"ID","name":"id","type":"string","placeholder":"62971ebae540870069668714","validation":[{"type":"regex","properties":{"regex":"([-:a-z0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Assignee ID"}}],"extractValue":{"type":"regex","regex":"^([-:a-z0-9]{2,})"}}]},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Custom Fields","name":"customFieldsUi","type":"fixedCollection","default":{},"placeholder":"Add Custom Field","typeOptions":{"multipleValues":true},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field","name":"fieldId","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Field","name":"list","type":"list","placeholder":"Select a Field...","typeOptions":{"searchListMethod":"getCustomFields"}},{"displayName":"ID","name":"id","type":"string","placeholder":"customfield_10035","validation":[{"type":"regex","properties":{"regex":"(customfield_[0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Field ID"}}],"extractValue":{"type":"regex","regex":"^(customfield_[0-9]{2,})"}}]},{"displayName":"Field Value","name":"fieldValue","type":"string","description":"Value of the field to set","default":""}]}]},{"displayName":"Issue Type","name":"issueType","type":"string","default":"","description":"Issue Types"},{"displayName":"Label Names or IDs","name":"labels","type":"multiOptions","description":"Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getLabels"},"default":[],"displayOptions":{"show":{"/jiraVersion":["cloud"]}}},{"displayName":"Labels","name":"serverLabels","type":"string","default":[],"displayOptions":{"show":{"/jiraVersion":["server"]}},"typeOptions":{"multipleValues":true}},{"displayName":"Parent Issue Key","name":"parentIssueKey","type":"string","default":""},{"displayName":"Priority","name":"priority","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Priority","name":"list","type":"list","placeholder":"Select a Priority...","typeOptions":{"searchListMethod":"getPriorities"}},{"displayName":"ID","name":"id","type":"string","placeholder":"1","validation":[{"type":"regex","properties":{"regex":"([0-9]{1,})[ \t]*","errorMessage":"Not a valid Jira Priority ID"}}],"extractValue":{"type":"regex","regex":"^([0-9]{1,})"}}]},{"displayName":"Reporter","name":"reporter","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Reporter","name":"list","type":"list","placeholder":"Select a Reporter...","typeOptions":{"searchListMethod":"getUsers","searchable":true}},{"displayName":"ID","name":"id","type":"string","placeholder":"62971ebae540870069668714","validation":[{"type":"regex","properties":{"regex":"([-:a-z0-9]{2,})[ \t]*","errorMessage":"Not a valid Jira Reporter ID"}}],"extractValue":{"type":"regex","regex":"^([-:a-z0-9]{2,})"}}]},{"displayName":"Summary","name":"summary","type":"string","default":""},{"displayName":"Status","name":"statusId","type":"resourceLocator","default":{"mode":"list","value":""},"modes":[{"displayName":"Status","name":"list","type":"list","placeholder":"Select a Status...","typeOptions":{"searchListMethod":"getTransitions"}},{"displayName":"ID","name":"id","type":"string","placeholder":"11","validation":[{"type":"regex","properties":{"regex":"([0-9]{1,})[ \t]*","errorMessage":"Not a valid Jira Status ID"}}],"extractValue":{"type":"regex","regex":"^([0-9]{1,})"}}]}]},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["delete"]}},"default":""},{"displayName":"Delete Subtasks","name":"deleteSubtasks","type":"boolean","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["delete"]}},"default":false},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["get"]}},"default":""},{"displayName":"Simplify","name":"simplifyOutput","type":"boolean","displayOptions":{"show":{"resource":["issue"],"operation":["get"]}},"default":false,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["get"]}},"options":[{"displayName":"Expand","name":"expand","type":"string","default":"","description":"<p>Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:\n\t\t\t\t<ul>\n\t\t\t\t\t<li><code>renderedFields</code> Returns field values rendered in HTML format.</li>\n\t\t\t\t\t<li><code>names</code> Returns the display name of each field.</li>\n\t\t\t\t\t<li><code>schema</code> Returns the schema describing a field type.</li>\n\t\t\t\t\t<li><code>transitions</code> Returns all possible transitions for the issue.</li>\n\t\t\t\t\t<li><code>editmeta</code> Returns information about how each field can be edited.</li>\n\t\t\t\t\t<li><code>changelog</code> Returns a list of recent updates to an issue, sorted by date, starting from the most recent.</li>\n\t\t\t\t\t<li><code>versionedRepresentations</code> Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.</li>\n\t\t\t\t</ul>"},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: <code>*all</code> Returns all fields. <code>*navigable</code> Returns navigable fields. Any issue field, prefixed with a minus to exclude."},{"displayName":"Fields By Key","name":"fieldsByKey","type":"boolean","default":false,"description":"Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID."},{"displayName":"Properties","name":"properties","type":"string","default":"","description":"A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: <code>*all</code> Returns all issue properties. Any issue property key, prefixed with a minus to exclude. Examples: <code>*all</code> Returns all properties. <code>*all</code>,-prop1 Returns all properties except prop1. <code>prop1,prop2</code> Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3."},{"displayName":"Update History","name":"updateHistory","type":"boolean","default":false,"description":"Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed field."}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["issue"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["issue"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","displayOptions":{"show":{"operation":["getAll"],"resource":["issue"]}},"default":{},"options":[{"displayName":"Expand","name":"expand","type":"multiOptions","default":[],"options":[{"name":"Changelog","value":"changelog","description":"Returns a list of recent updates to an issue, sorted by date, starting from the most recent"},{"name":"Editmeta","value":"editmeta","description":"Returns information about how each field can be edited"},{"name":"Names","value":"names","description":"Returns the display name of each field"},{"name":"Operations","value":"operations","description":"Returns all possible operations for the issue"},{"name":"Rendered Fields","value":"renderedFields","description":"Returns field values rendered in HTML format"},{"name":"Schema","value":"schema","description":"Returns the schema describing a field type"},{"name":"Transitions","value":"transitions","description":"Returns all possible transitions for the issue"},{"name":"Versioned Representations","value":"versionedRepresentations","description":"JSON array containing each version of a field's value"}],"description":"Use expand to include additional information about issues in the response"},{"displayName":"Fields","name":"fields","type":"string","default":"*navigable","description":"A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: <code>*all</code> Returns all fields. <code>*navigable</code> Returns navigable fields. Any issue field, prefixed with a minus to exclude."},{"displayName":"Fields By Key","name":"fieldsByKey","type":"boolean","default":false,"description":"Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID."},{"displayName":"JQL","name":"jql","type":"string","default":"","description":"A JQL expression"}]},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["changelog"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["issue"],"operation":["changelog"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["issue"],"operation":["changelog"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["notify"]}},"default":""},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["issue"],"operation":["notify"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["notify"]}},"options":[{"displayName":"HTML Body","name":"htmlBody","type":"string","default":"","description":"The HTML body of the email notification for the issue"},{"displayName":"Subject","name":"subject","type":"string","default":"","description":"The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary."},{"displayName":"Text Body","name":"textBody","type":"string","default":"","description":"The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary."}]},{"displayName":"Notification Recipients","name":"notificationRecipientsUi","type":"fixedCollection","placeholder":"Add Recipients","typeOptions":{"multipleValues":false},"description":"The recipients of the email notification for the issue","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["notify"],"jsonParameters":[false]}},"options":[{"name":"notificationRecipientsValues","displayName":"Recipients","values":[{"displayName":"Reporter","name":"reporter","type":"boolean","description":"Whether the notification should be sent to the issue's reporter","default":false},{"displayName":"Assignee","name":"assignee","type":"boolean","default":false,"description":"Whether the notification should be sent to the issue's assignees"},{"displayName":"Watchers","name":"watchers","type":"boolean","default":false,"description":"Whether the notification should be sent to the issue's assignees"},{"displayName":"Voters","name":"voters","type":"boolean","default":false,"description":"Whether the notification should be sent to the issue's voters"},{"displayName":"User Names or IDs","name":"users","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getUsers"},"default":[],"description":"List of users to receive the notification. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Group Names or IDs","name":"groups","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getGroups"},"default":[],"description":"List of groups to receive the notification. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]}]},{"displayName":"Notification Recipients","name":"notificationRecipientsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["issue"],"operation":["notify"],"jsonParameters":[true]}},"default":"","description":"The recipients of the email notification for the issue"},{"displayName":"Notification Recipients Restrictions","name":"notificationRecipientsRestrictionsUi","type":"fixedCollection","placeholder":"Add Recipients Restriction","typeOptions":{"multipleValues":false},"description":"Restricts the notifications to users with the specified permissions","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["notify"],"jsonParameters":[false]}},"options":[{"name":"notificationRecipientsRestrictionsValues","displayName":"Recipients Restrictions","values":[{"displayName":"User Names or IDs","name":"users","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getUsers"},"default":[],"description":"List of users to receive the notification. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Group Names or IDs","name":"groups","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getGroups"},"default":[],"description":"List of groups to receive the notification. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]}]},{"displayName":"Notification Recipients Restrictions","name":"notificationRecipientsRestrictionsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["issue"],"operation":["notify"],"jsonParameters":[true]}},"default":"","description":"Restricts the notifications to users with the specified permissions"},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["transitions"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["transitions"]}},"options":[{"displayName":"Expand","name":"expand","type":"string","default":"","description":"Use expand to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in Transition issue."},{"displayName":"Transition ID","name":"transitionId","type":"string","default":"","description":"The ID of the transition"},{"displayName":"Skip Remote Only Condition","name":"skipRemoteOnlyCondition","type":"boolean","default":false,"description":"Whether transitions with the condition Hide From User Condition are included in the response"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["issueAttachment"]}},"options":[{"name":"Add","value":"add","description":"Add attachment to issue","action":"Add an attachment to an issue"},{"name":"Get","value":"get","description":"Get an attachment","action":"Get an attachment from an issue"},{"name":"Get Many","value":"getAll","description":"Get many attachments","action":"Get many issue attachments"},{"name":"Remove","value":"remove","description":"Remove an attachment","action":"Remove an attachment from an issue"}],"default":"add"},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueAttachment"],"operation":["add"]}},"default":""},{"displayName":"Binary Property","displayOptions":{"show":{"resource":["issueAttachment"],"operation":["add"]}},"name":"binaryPropertyName","type":"string","default":"data","description":"Object property name which holds binary data","required":true},{"displayName":"Attachment ID","name":"attachmentId","type":"string","required":true,"displayOptions":{"show":{"resource":["issueAttachment"],"operation":["get"]}},"default":"","description":"The ID of the attachment"},{"displayName":"Download","name":"download","type":"boolean","default":false,"required":true,"displayOptions":{"show":{"resource":["issueAttachment"],"operation":["get"]}}},{"displayName":"Binary Property","name":"binaryProperty","type":"string","default":"data","displayOptions":{"show":{"resource":["issueAttachment"],"operation":["get"],"download":[true]}},"description":"Object property name which holds binary data","required":true},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueAttachment"],"operation":["getAll"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["issueAttachment"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["issueAttachment"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Download","name":"download","type":"boolean","default":false,"required":true,"displayOptions":{"show":{"resource":["issueAttachment"],"operation":["getAll"]}}},{"displayName":"Binary Property","name":"binaryProperty","type":"string","default":"data","displayOptions":{"show":{"resource":["issueAttachment"],"operation":["getAll"],"download":[true]}},"description":"Object property name which holds binary data","required":true},{"displayName":"Attachment ID","name":"attachmentId","type":"string","required":true,"displayOptions":{"show":{"resource":["issueAttachment"],"operation":["remove"]}},"default":"","description":"The ID of the attachment"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["issueComment"]}},"options":[{"name":"Add","value":"add","description":"Add comment to issue","action":"Add a comment"},{"name":"Get","value":"get","description":"Get a comment","action":"Get a comment"},{"name":"Get Many","value":"getAll","description":"Get many comments","action":"Get many comments"},{"name":"Remove","value":"remove","description":"Remove a comment","action":"Remove a comment"},{"name":"Update","value":"update","description":"Update a comment","action":"Update a comment"}],"default":"add"},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["add"]}},"default":"","description":"issueComment Key"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["issueComment"],"operation":["add"]}}},{"displayName":"Comment","name":"comment","type":"string","default":"","displayOptions":{"show":{"resource":["issueComment"],"operation":["add"],"jsonParameters":[false]}},"description":"Comment's text"},{"displayName":"Document Format (JSON)","name":"commentJson","type":"json","default":"","displayOptions":{"show":{"resource":["issueComment"],"operation":["add"],"jsonParameters":[true]}},"description":"The Atlassian Document Format (ADF). Online builder can be found <a href=\"https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/\">here</a>."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issueComment"],"operation":["add"]}},"options":[{"displayName":"Expand","name":"expand","type":"options","options":[{"name":"Rendered Body","value":"renderedBody"}],"default":"","description":"Use expand to include additional information about comments in the response. This parameter accepts Rendered Body, which returns the comment body rendered in HTML."}]},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["get"]}},"default":"","description":"The ID or key of the issue"},{"displayName":"Comment ID","name":"commentId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["get"]}},"description":"The ID of the comment"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issueComment"],"operation":["get"]}},"options":[{"displayName":"Expand","name":"expand","type":"options","options":[{"name":"Rendered Body","value":"renderedBody"}],"default":"","description":"Use expand to include additional information about comments in the response. This parameter accepts Rendered Body, which returns the comment body rendered in HTML."}]},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["getAll"]}},"default":"","description":"The ID or key of the issue"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["issueComment"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["issueComment"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issueComment"],"operation":["getAll"]}},"options":[{"displayName":"Expand","name":"expand","type":"options","options":[{"name":"Rendered Body","value":"renderedBody"}],"default":"","description":"Use expand to include additional information about comments in the response. This parameter accepts Rendered Body, which returns the comment body rendered in HTML."}]},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["remove"]}},"default":"","description":"The ID or key of the issue"},{"displayName":"Comment ID","name":"commentId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["remove"]}},"description":"The ID of the comment"},{"displayName":"Issue Key","name":"issueKey","type":"string","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["update"]}},"default":"","description":"The Issue Comment key"},{"displayName":"Comment ID","name":"commentId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["issueComment"],"operation":["update"]}},"description":"The ID of the comment"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["issueComment"],"operation":["update"]}}},{"displayName":"Comment","name":"comment","type":"string","default":"","displayOptions":{"show":{"resource":["issueComment"],"operation":["update"],"jsonParameters":[false]}},"description":"Comment's text"},{"displayName":"Document Format (JSON)","name":"commentJson","type":"json","default":"","displayOptions":{"show":{"resource":["issueComment"],"operation":["update"],"jsonParameters":[true]}},"description":"The Atlassian Document Format (ADF). Online builder can be found <a href=\"https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/\">here</a>."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issueComment"],"operation":["update"]}},"options":[{"displayName":"Expand","name":"expand","type":"options","options":[{"name":"Rendered Body","value":"renderedBody"}],"default":"","description":"Use expand to include additional information about comments in the response. This parameter accepts Rendered Body, which returns the comment body rendered in HTML."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Create","value":"create","description":"Create a new 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"}],"default":"create"},{"displayName":"Username","name":"username","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}}},{"displayName":"Email Address","name":"emailAddress","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}}},{"displayName":"Display Name","name":"displayName","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"options":[{"displayName":"Password","name":"password","type":"string","default":"","description":"Password for the user. If a password is not set, a random password is generated.","typeOptions":{"password":true}},{"displayName":"Notification","name":"notification","type":"boolean","default":false,"description":"Whether to send the user an email confirmation that they have been added to Jira"}]},{"displayName":"Account ID","name":"accountId","type":"string","default":"","description":"Account ID of the user to delete","displayOptions":{"show":{"resource":["user"],"operation":["delete"]}}},{"displayName":"Account ID","name":"accountId","type":"string","default":"","description":"Account ID of the user to retrieve","displayOptions":{"show":{"resource":["user"],"operation":["get"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"options":[{"displayName":"Expand","name":"expand","type":"multiOptions","default":[],"description":"Include more information about the user","options":[{"name":"Groups","value":"groups","description":"Include all groups to which the user belongs"},{"name":"Application Roles","value":"applicationRoles","description":"Include details of all the applications the user can access"}]}]}]

operations:
  [{"type":"resource","resource":"issue","name":"Issue"},{"type":"resource","resource":"issueAttachment","name":"Issue Attachment"},{"type":"resource","resource":"issueComment","name":"Issue Comment"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"changelog","name":"Changelog","action":"Get an issue changelog","resources":["issue"]},{"type":"operation","operation":"create","name":"Create","action":"Create an issue","resources":["issue"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an issue","resources":["issue"]},{"type":"operation","operation":"get","name":"Get","action":"Get an issue","resources":["issue"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many issues","resources":["issue"]},{"type":"operation","operation":"notify","name":"Notify","action":"Create an email notification for an issue","resources":["issue"]},{"type":"operation","operation":"transitions","name":"Status","action":"Get the status of an issue","resources":["issue"]},{"type":"operation","operation":"update","name":"Update","action":"Update an issue","resources":["issue"]},{"type":"operation","operation":"add","name":"Add","action":"Add an attachment to an issue","resources":["issueAttachment"]},{"type":"operation","operation":"get","name":"Get","action":"Get an attachment from an issue","resources":["issueAttachment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many issue attachments","resources":["issueAttachment"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove an attachment from an issue","resources":["issueAttachment"]},{"type":"operation","operation":"add","name":"Add","action":"Add a comment","resources":["issueComment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a comment","resources":["issueComment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many comments","resources":["issueComment"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a comment","resources":["issueComment"]},{"type":"operation","operation":"update","name":"Update","action":"Update a comment","resources":["issueComment"]},{"type":"operation","operation":"create","name":"Create","action":"Create a user","resources":["user"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a user","resources":["user"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]}]

credentials_required:
  [{"name":"jiraSoftwareCloudApi","required":true,"displayOptions":{"show":{"jiraVersion":["cloud"]}}},{"name":"jiraSoftwareServerApi","required":true,"displayOptions":{"show":{"jiraVersion":["server"]}}}]


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

  # Jira Trigger node

  [Jira](https://www.atlassian.com/software/jira){:target=_blank .external-link} is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management.

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

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

properties_schema:
  [{"displayName":"Jira Version","name":"jiraVersion","type":"options","options":[{"name":"Cloud","value":"cloud"},{"name":"Server (Self Hosted)","value":"server"}],"default":"cloud"},{"displayName":"Incoming Authentication","name":"incomingAuthentication","type":"options","options":[{"name":"Query Auth","value":"queryAuth"},{"name":"None","value":"none"}],"default":"none","description":"If authentication should be activated for the webhook (makes it more secure)"},{"displayName":"Events","name":"events","type":"multiOptions","options":[{"name":"*","value":"*"},{"name":"Board Configuration Changed","value":"board_configuration_changed"},{"name":"Board Created","value":"board_created"},{"name":"Board Deleted","value":"board_deleted"},{"name":"Board Updated","value":"board_updated"},{"name":"Comment Created","value":"comment_created"},{"name":"Comment Deleted","value":"comment_deleted"},{"name":"Comment Updated","value":"comment_updated"},{"name":"Issue Created","value":"jira:issue_created"},{"name":"Issue Deleted","value":"jira:issue_deleted"},{"name":"Issue Link Created","value":"issuelink_created"},{"name":"Issue Link Deleted","value":"issuelink_deleted"},{"name":"Issue Updated","value":"jira:issue_updated"},{"name":"Option Attachments Changed","value":"option_attachments_changed"},{"name":"Option Issue Links Changed","value":"option_issuelinks_changed"},{"name":"Option Subtasks Changed","value":"option_subtasks_changed"},{"name":"Option Timetracking Changed","value":"option_timetracking_changed"},{"name":"Option Unassigned Issues Changed","value":"option_unassigned_issues_changed"},{"name":"Option Voting Changed","value":"option_voting_changed"},{"name":"Option Watching Changed","value":"option_watching_changed"},{"name":"Project Created","value":"project_created"},{"name":"Project Deleted","value":"project_deleted"},{"name":"Project Updated","value":"project_updated"},{"name":"Sprint Closed","value":"sprint_closed"},{"name":"Sprint Created","value":"sprint_created"},{"name":"Sprint Deleted","value":"sprint_deleted"},{"name":"Sprint Started","value":"sprint_started"},{"name":"Sprint Updated","value":"sprint_updated"},{"name":"User Created","value":"user_created"},{"name":"User Deleted","value":"user_deleted"},{"name":"User Updated","value":"user_updated"},{"name":"Version Created","value":"jira:version_created"},{"name":"Version Deleted","value":"jira:version_deleted"},{"name":"Version Moved","value":"jira:version_moved"},{"name":"Version Released","value":"jira:version_released"},{"name":"Version Unreleased","value":"jira:version_unreleased"},{"name":"Version Updated","value":"jira:version_updated"},{"name":"Worklog Created","value":"worklog_created"},{"name":"Worklog Deleted","value":"worklog_deleted"},{"name":"Worklog Updated","value":"worklog_updated"}],"required":true,"default":[],"description":"The events to listen to"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Exclude Body","name":"excludeBody","type":"boolean","default":false,"description":"Whether a request with empty body will be sent to the URL. Leave unchecked if you want to receive JSON."},{"displayName":"Filter","name":"filter","type":"string","default":"","placeholder":"Project = JRA AND resolution = Fixed","description":"You can specify a JQL query to send only events triggered by matching issues. The JQL filter only applies to events under the Issue and Comment columns."},{"displayName":"Include Fields","name":"includeFields","type":"multiOptions","options":[{"name":"Attachment ID","value":"attachment.id"},{"name":"Board ID","value":"board.id"},{"name":"Comment ID","value":"comment.id"},{"name":"Issue ID","value":"issue.id"},{"name":"Merge Version ID","value":"mergeVersion.id"},{"name":"Modified User Account ID","value":"modifiedUser.accountId"},{"name":"Modified User Key","value":"modifiedUser.key"},{"name":"Modified User Name","value":"modifiedUser.name"},{"name":"Project ID","value":"project.id"},{"name":"Project Key","value":"project.key"},{"name":"Propery Key","value":"property.key"},{"name":"Sprint ID","value":"sprint.id"},{"name":"Version ID","value":"version.id"},{"name":"Worklog ID","value":"worklog.id"}],"default":[]}]}]

credentials_required:
  [{"name":"jiraSoftwareCloudApi","required":true,"displayOptions":{"show":{"jiraVersion":["cloud"]}}},{"name":"jiraSoftwareServerApi","required":true,"displayOptions":{"show":{"jiraVersion":["server"]}}},{"name":"httpQueryAuth","required":true,"displayOptions":{"show":{"incomingAuthentication":["queryAuth"]}}}]


node_type: jotFormTrigger
package_name: n8n-nodes-base
display_name: JotForm Trigger
description: Handle JotForm events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"jotFormApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: JotForm Trigger node documentation
  description: Learn how to use the JotForm Trigger node in n8n. Follow technical documentation to integrate JotForm Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # JotForm Trigger node

  [JotForm](https://www.jotform.com/){:target=_blank .external-link} is an online form building service. JotForm's software creates forms with a drag and drop creation tool and an option to encrypt user data.

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

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

properties_schema:
  [{"displayName":"Form Name or ID","name":"form","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"getForms"},"default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>"},{"displayName":"Resolve Data","name":"resolveData","type":"boolean","default":true,"description":"By default does the webhook-data use internal keys instead of the names. If this option gets activated, it will resolve the keys automatically to the actual names."},{"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: kafka
package_name: n8n-nodes-base
display_name: Kafka
description: Sends messages to a Kafka topic
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"kafka","required":true,"testedBy":"kafkaConnectionTest"}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Kafka node documentation
  description: Learn how to use the Kafka node in n8n. Follow technical documentation to integrate Kafka node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Kafka node

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

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

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

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

  ## Operations

  - Send message

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Topic","name":"topic","type":"string","default":"","placeholder":"topic-name","description":"Name of the queue of topic to publish to"},{"displayName":"Send Input Data","name":"sendInputData","type":"boolean","default":true,"description":"Whether to send the the data the node receives as JSON to Kafka"},{"displayName":"Message","name":"message","type":"string","displayOptions":{"show":{"sendInputData":[false]}},"default":"","description":"The message to be sent"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false},{"displayName":"Use Schema Registry","name":"useSchemaRegistry","type":"boolean","default":false,"description":"Whether to use Confluent Schema Registry"},{"displayName":"Schema Registry URL","name":"schemaRegistryUrl","type":"string","required":true,"displayOptions":{"show":{"useSchemaRegistry":[true]}},"placeholder":"https://schema-registry-domain:8081","default":"","description":"URL of the schema registry"},{"displayName":"Use Key","name":"useKey","type":"boolean","default":false,"description":"Whether to use a message key"},{"displayName":"Key","name":"key","type":"string","required":true,"displayOptions":{"show":{"useKey":[true]}},"placeholder":"","default":"","description":"The message key"},{"displayName":"Event Name","name":"eventName","type":"string","required":true,"displayOptions":{"show":{"useSchemaRegistry":[true]}},"default":"","description":"Namespace and Name of Schema in Schema Registry (namespace.name)"},{"displayName":"Headers","name":"headersUi","placeholder":"Add Header","type":"fixedCollection","displayOptions":{"show":{"jsonParameters":[false]}},"typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"headerValues","displayName":"Header","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Headers (JSON)","name":"headerParametersJson","type":"json","displayOptions":{"show":{"jsonParameters":[true]}},"default":"","description":"Header parameters as JSON (flat object)"},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Option","options":[{"displayName":"Acks","name":"acks","type":"boolean","default":false,"description":"Whether or not producer must wait for acknowledgement from all replicas"},{"displayName":"Compression","name":"compression","type":"boolean","default":false,"description":"Whether to send the data in a compressed format using the GZIP codec"},{"displayName":"Timeout","name":"timeout","type":"number","default":30000,"description":"The time to await a response in ms"}]}]


node_type: kafkaTrigger
package_name: n8n-nodes-base
display_name: Kafka Trigger
description: Consume messages from a Kafka topic
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"kafka","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Kafka Trigger node documentation
  description: Learn how to use the Kafka Trigger node in n8n. Follow technical documentation to integrate Kafka Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Kafka Trigger node

  [Kafka](https://kafka.apache.org/){:target=_blank .external-link} is an open-source distributed event streaming platform that one can use for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.

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

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

properties_schema:
  [{"displayName":"Topic","name":"topic","type":"string","default":"","required":true,"placeholder":"topic-name","description":"Name of the queue of topic to consume from"},{"displayName":"Group ID","name":"groupId","type":"string","default":"","required":true,"placeholder":"n8n-kafka","description":"ID of the consumer group"},{"displayName":"Use Schema Registry","name":"useSchemaRegistry","type":"boolean","default":false,"description":"Whether to use Confluent Schema Registry"},{"displayName":"Schema Registry URL","name":"schemaRegistryUrl","type":"string","required":true,"displayOptions":{"show":{"useSchemaRegistry":[true]}},"placeholder":"https://schema-registry-domain:8081","default":"","description":"URL of the schema registry"},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Option","options":[{"displayName":"Allow Topic Creation","name":"allowAutoTopicCreation","type":"boolean","default":false,"description":"Whether to allow sending message to a previously non exisiting topic"},{"displayName":"Auto Commit Threshold","name":"autoCommitThreshold","type":"number","default":0,"description":"The consumer will commit offsets after resolving a given number of messages"},{"displayName":"Auto Commit Interval","name":"autoCommitInterval","type":"number","default":0,"description":"The consumer will commit offsets after a given period, for example, five seconds","hint":"Value in milliseconds"},{"displayName":"Heartbeat Interval","name":"heartbeatInterval","type":"number","default":3000,"description":"Heartbeats are used to ensure that the consumer's session stays active","hint":"The value must be set lower than Session Timeout"},{"displayName":"Max Number of Requests","name":"maxInFlightRequests","type":"number","default":1,"description":"The maximum number of unacknowledged requests the client will send on a single connection"},{"displayName":"Read Messages From Beginning","name":"fromBeginning","type":"boolean","default":true,"description":"Whether to read message from beginning"},{"displayName":"JSON Parse Message","name":"jsonParseMessage","type":"boolean","default":false,"description":"Whether to try to parse the message to an object"},{"displayName":"Parallel Processing","name":"parallelProcessing","type":"boolean","default":true,"displayOptions":{"hide":{"@version":[1]}},"description":"Whether to process messages in parallel or by keeping the message in order"},{"displayName":"Only Message","name":"onlyMessage","type":"boolean","displayOptions":{"show":{"jsonParseMessage":[true]}},"default":false,"description":"Whether to return only the message property"},{"displayName":"Return Headers","name":"returnHeaders","type":"boolean","default":false,"description":"Whether to return the headers received from Kafka"},{"displayName":"Session Timeout","name":"sessionTimeout","type":"number","default":30000,"description":"The time to await a response in ms","hint":"Value in milliseconds"}]}]


node_type: keap
package_name: n8n-nodes-base
display_name: Keap
description: Consume Keap API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"keapOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Keap node documentation
  description: Learn how to use the Keap node in n8n. Follow technical documentation to integrate Keap node into your workflows.
  contentType: [integration, reference]
  ---

  # Keap node

  Use the Keap node to automate work in Keap, and integrate Keap with other applications. n8n has built-in support for a wide range of Keap features, including creating, updating, deleting, and getting companies, products, ecommerce orders, emails, and files. 

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

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

  ## Operations

  * Company
      * Create a company
      * Retrieve all companies
  * Contact
      * Create/update a contact
      * Delete an contact
      * Retrieve an contact
      * Retrieve all contacts
  * Contact Note
      * Create a note
      * Delete a note
      * Get a notes
      * Retrieve all notes
      * Update a note
  * Contact Tag
      * Add a list of tags to a contact
      * Delete a contact's tag
      * Retrieve all contact's tags
  * Ecommerce Order
      * Create an ecommerce order
      * Get an ecommerce order
      * Delete an ecommerce order
      * Retrieve all ecommerce orders
  * Ecommerce Product
      * Create an ecommerce product
      * Delete an ecommerce product
      * Get an ecommerce product
      * Retrieve all ecommerce product
  * Email
      * Create a record of an email sent to a contact
      * Retrieve all sent emails
      * Send Email
  * File
      * Delete a file
      * Retrieve all files
      * Upload a file

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Company","value":"company"},{"name":"Contact","value":"contact"},{"name":"Contact Note","value":"contactNote"},{"name":"Contact Tag","value":"contactTag"},{"name":"Ecommerce Order","value":"ecommerceOrder"},{"name":"Ecommerce Product","value":"ecommerceProduct"},{"name":"Email","value":"email"},{"name":"File","value":"file"}],"default":"company"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["company"]}},"options":[{"name":"Create","value":"create","description":"Create a company","action":"Create a company"},{"name":"Get Many","value":"getAll","description":"Retrieve many companies","action":"Get many companies"}],"default":"create"},{"displayName":"Company Name","name":"companyName","required":true,"type":"string","displayOptions":{"show":{"operation":["create"],"resource":["company"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["company"]}},"options":[{"displayName":"Email","name":"emailAddress","type":"string","default":""},{"displayName":"Notes","name":"notes","type":"string","default":""},{"displayName":"Opt In Reason","name":"optInReason","type":"string","default":""},{"displayName":"Website","name":"website","type":"string","default":""}]},{"displayName":"Addresses","name":"addressesUi","type":"fixedCollection","typeOptions":{"multipleValues":false},"default":{},"placeholder":"Add Address","displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"options":[{"name":"addressesValues","displayName":"Address","values":[{"displayName":"Country Code","name":"countryCode","type":"string","default":"","description":"ISO Alpha-3 Code"},{"displayName":"Line 1","name":"line1","type":"string","default":""},{"displayName":"Line 2","name":"line2","type":"string","default":""},{"displayName":"Locality","name":"locality","type":"string","default":""},{"displayName":"Postal Code","name":"postalCode","type":"string","default":""},{"displayName":"Region","name":"region","type":"string","default":""},{"displayName":"Zip Code","name":"zipCode","type":"string","default":""},{"displayName":"Zip Four","name":"zipFour","type":"string","default":""}]}]},{"displayName":"Faxes","name":"faxesUi","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":false},"placeholder":"Add Fax","displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"options":[{"name":"faxesValues","displayName":"Fax","values":[{"displayName":"Type","name":"type","type":"string","default":""},{"displayName":"Number","name":"number","type":"string","default":""}]}]},{"displayName":"Phones","name":"phonesUi","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"placeholder":"Add Phone","displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"options":[{"name":"phonesValues","displayName":"Phones","values":[{"displayName":"Type","name":"type","type":"string","default":""},{"displayName":"Number","name":"number","type":"string","default":""}]}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["company"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["company"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["company"]}},"options":[{"displayName":"Company Name","name":"companyName","type":"string","default":"","description":"Company name to query on"},{"displayName":"Order","name":"order","type":"options","options":[{"name":"Date Created","value":"datecreated"},{"name":"ID","value":"id"},{"name":"Name","value":"name"}],"default":"","description":"Attribute to order items by"},{"displayName":"Order Direction","name":"orderDirection","type":"options","options":[{"name":"ASC","value":"ascending"},{"name":"DES","value":"descending"}],"default":""},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Comma-delimited list of Company properties to include in the response. (Fields such as notes, fax_number and custom_fields aren't included, by default.)."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"options":[{"name":"Create or Update","value":"upsert","description":"Create a new contact, or update the current one if it already exists (upsert)","action":"Create or update a contact"},{"name":"Delete","value":"delete","description":"Delete an contact","action":"Delete a contact"},{"name":"Get","value":"get","description":"Retrieve an contact","action":"Get a contact"},{"name":"Get Many","value":"getAll","description":"Retrieve many contacts","action":"Get many contacts"}],"default":"upsert"},{"displayName":"Duplicate Option","name":"duplicateOption","required":true,"type":"options","options":[{"name":"Email","value":"email"},{"name":"Email And Name","value":"emailAndName"}],"displayOptions":{"show":{"operation":["upsert"],"resource":["contact"]}},"default":"email","description":"Performs duplicate checking by one of the following options: Email, EmailAndName. If a match is found using the option provided, the existing contact will be updated."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["upsert"],"resource":["contact"]}},"options":[{"displayName":"Anniversary","name":"anniversary","type":"dateTime","default":""},{"displayName":"Company ID","name":"companyId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Contact Type Name or ID","name":"contactType","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getContactTypes"},"default":""},{"displayName":"Family Name","name":"familyName","type":"string","default":""},{"displayName":"Given Name","name":"givenName","type":"string","default":""},{"displayName":"IP Address","name":"ipAddress","type":"string","default":""},{"displayName":"Job Title","name":"jobTitle","type":"string","default":""},{"displayName":"Lead Source ID","name":"leadSourceId","type":"number","default":0},{"displayName":"Middle Name","name":"middleName","type":"string","default":""},{"displayName":"Opt In Reason","name":"optInReason","type":"string","default":""},{"displayName":"Owner Name or ID","name":"ownerId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"default":""},{"displayName":"Preferred Locale","name":"preferredLocale","type":"string","placeholder":"en","default":""},{"displayName":"Preferred Name","name":"preferredName","type":"string","default":""},{"displayName":"Source Type","name":"sourceType","type":"options","options":[{"name":"API","value":"API"},{"name":"Import","value":"IMPORT"},{"name":"Landing Page","value":"LANDINGPAGE"},{"name":"Manual","value":"MANUAL"},{"name":"Other","value":"OTHER"},{"name":"Unknown","value":"UNKNOWN"}],"default":""},{"displayName":"Spouse Name","name":"spouseName","type":"string","default":""},{"displayName":"Timezone Name or ID","name":"timezone","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTimezones"},"default":""},{"displayName":"Website","name":"website","type":"string","default":""}]},{"displayName":"Addresses","name":"addressesUi","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"placeholder":"Add Address","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"options":[{"name":"addressesValues","displayName":"Address","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Billing","value":"BILLING"},{"name":"Shipping","value":"SHIPPING"},{"name":"Other","value":"OTHER"}],"default":""},{"displayName":"Country Code Name or ID","name":"countryCode","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCountries"},"default":""},{"displayName":"Line 1","name":"line1","type":"string","default":""},{"displayName":"Line 2","name":"line2","type":"string","default":""},{"displayName":"Locality","name":"locality","type":"string","default":""},{"displayName":"Postal Code","name":"postalCode","type":"string","default":""},{"displayName":"Region","name":"region","type":"string","default":""},{"displayName":"Zip Code","name":"zipCode","type":"string","default":""},{"displayName":"Zip Four","name":"zipFour","type":"string","default":""}]}]},{"displayName":"Emails","name":"emailsUi","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"placeholder":"Add Email","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"options":[{"name":"emailsValues","displayName":"Email","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Email 1","value":"EMAIL1"},{"name":"Email 2","value":"EMAIL2"},{"name":"Email 3","value":"EMAIL3"}],"default":""},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""}]}]},{"displayName":"Faxes","name":"faxesUi","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"placeholder":"Add Fax","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"options":[{"name":"faxesValues","displayName":"Fax","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Fax 1","value":"FAX1"},{"name":"Fax 2","value":"FAX2"}],"default":""},{"displayName":"Number","name":"number","type":"string","default":""}]}]},{"displayName":"Phones","name":"phonesUi","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"placeholder":"Add Phone","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"options":[{"name":"phonesValues","displayName":"Phones","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Phone 1","value":"PHONE1"},{"name":"Phone 2","value":"PHONE2"},{"name":"Phone 3","value":"PHONE3"},{"name":"Phone 4","value":"PHONE4"},{"name":"Phone 5","value":"PHONE5"}],"default":""},{"displayName":"Number","name":"number","type":"string","default":""}]}]},{"displayName":"Social Accounts","name":"socialAccountsUi","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"placeholder":"Add Social Account","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"options":[{"name":"socialAccountsValues","displayName":"Social Account","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"Facebook","value":"Facebook"},{"name":"Twitter","value":"Twitter"},{"name":"LinkedIn","value":"LinkedIn"}],"default":""},{"displayName":"Name","name":"name","type":"string","default":""}]}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["contact"]}},"default":""},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["contact"]}},"default":""},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Options","default":{},"displayOptions":{"show":{"operation":["get"],"resource":["contact"]}},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Comma-delimited list of Contact properties to include in the response. (Some fields such as lead_source_id, custom_fields, and job_title aren't included, by default.)."}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["contact"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["contact"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["contact"]}},"options":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Given Name","name":"givenName","type":"string","default":""},{"displayName":"Family Name","name":"familyName","type":"string","default":""},{"displayName":"Order","name":"order","type":"options","options":[{"name":"Date","value":"date"},{"name":"Email","value":"email"},{"name":"ID","value":"id"},{"name":"Name","value":"name"}],"default":"","description":"Attribute to order items by"},{"displayName":"Order Direction","name":"orderDirection","type":"options","options":[{"name":"ASC","value":"ascending"},{"name":"DES","value":"descending"}],"default":""},{"displayName":"Since","name":"since","type":"dateTime","default":"","description":"Date to start searching from on LastUpdated"},{"displayName":"Until","name":"until","type":"dateTime","default":"","description":"Date to search to on LastUpdated"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contactNote"]}},"options":[{"name":"Create","value":"create","description":"Create a note","action":"Create a contact note"},{"name":"Delete","value":"delete","description":"Delete a note","action":"Delete a contact note"},{"name":"Get","value":"get","description":"Get a notes","action":"Get a contact note"},{"name":"Get Many","value":"getAll","description":"Retrieve many notes","action":"Get many contact notes"},{"name":"Update","value":"update","description":"Update a note","action":"Update a contact note"}],"default":"create"},{"displayName":"User Name or ID","name":"userId","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"displayOptions":{"show":{"operation":["create"],"resource":["contactNote"]}},"default":"","description":"The infusionsoft user to create the note on behalf of. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Contact ID","name":"contactId","type":"string","displayOptions":{"show":{"operation":["create"],"resource":["contactNote"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["contactNote"]}},"options":[{"displayName":"Body","name":"body","type":"string","default":""},{"displayName":"Title","name":"title","type":"string","default":""},{"displayName":"Type","name":"type","type":"options","options":[{"name":"Appointment","value":"appointment"},{"name":"Call","value":"call"},{"name":"Email","value":"email"},{"name":"Fax","value":"fax"},{"name":"Letter","value":"letter"},{"name":"Other","value":"other"}],"default":""}]},{"displayName":"Note ID","name":"noteId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["contactNote"]}},"default":""},{"displayName":"Note ID","name":"noteId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["contactNote"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["contactNote"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["contactNote"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["contactNote"]}},"options":[{"displayName":"Contact ID","name":"contactId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"User Name or ID","name":"userId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"default":""}]},{"displayName":"Note ID","name":"noteId","type":"string","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["contactNote"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["update"],"resource":["contactNote"]}},"options":[{"displayName":"Body","name":"body","type":"string","default":""},{"displayName":"Contact ID","name":"contactId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Title","name":"title","type":"string","default":""},{"displayName":"Type","name":"type","type":"options","options":[{"name":"Appointment","value":"appointment"},{"name":"Call","value":"call"},{"name":"Email","value":"email"},{"name":"Fax","value":"fax"},{"name":"Letter","value":"letter"},{"name":"Other","value":"other"}],"default":""},{"displayName":"User Name or ID","name":"userId","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The infusionsoft user to create the note on behalf of. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contactTag"]}},"options":[{"name":"Create","value":"create","description":"Add a list of tags to a contact","action":"Create a contact tag"},{"name":"Delete","value":"delete","description":"Delete a contact's tag","action":"Delete a contact tag"},{"name":"Get Many","value":"getAll","description":"Retrieve many contact's tags","action":"Get many contact tags"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["contactTag"]}},"default":""},{"displayName":"Tag Names or IDs","name":"tagIds","type":"multiOptions","description":"Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTags"},"required":true,"displayOptions":{"show":{"operation":["create"],"resource":["contactTag"]}},"default":[]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["contactTag"]}},"default":""},{"displayName":"Tag IDs","name":"tagIds","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["contactTag"]}},"default":"Tag IDs, multiple ids can be set separated by comma."},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["getAll"],"resource":["contactTag"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["contactTag"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["contactTag"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["ecommerceOrder"]}},"options":[{"name":"Create","value":"create","description":"Create an ecommerce order","action":"Create an e-commerce order"},{"name":"Get","value":"get","description":"Get an ecommerce order","action":"Get an e-commerce order"},{"name":"Delete","value":"delete","description":"Delete an ecommerce order","action":"Delete an e-commerce order"},{"name":"Get Many","value":"getAll","description":"Retrieve many ecommerce orders","action":"Get many e-commerce orders"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceOrder"]}},"default":""},{"displayName":"Order Date","name":"orderDate","type":"dateTime","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceOrder"]}},"default":""},{"displayName":"Order Title","name":"orderTitle","type":"string","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceOrder"]}},"default":""},{"displayName":"Order Type","name":"orderType","type":"options","options":[{"name":"Offline","value":"offline"},{"name":"Online","value":"online"}],"required":true,"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceOrder"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceOrder"]}},"options":[{"displayName":"Lead Affiliate ID","name":"leadAffiliateId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Promo Codes","name":"promoCodes","type":"string","default":"","description":"Uses multiple strings separated by comma as promo codes. The corresponding discount will be applied to the order."},{"displayName":"Sales Affiliate ID","name":"salesAffiliateId","type":"number","typeOptions":{"minValue":0},"default":0}]},{"displayName":"Shipping Address","name":"addressUi","type":"fixedCollection","typeOptions":{"multipleValues":false},"default":{},"placeholder":"Add Address","displayOptions":{"show":{"resource":["ecommerceOrder"],"operation":["create"]}},"options":[{"name":"addressValues","displayName":"Address","values":[{"displayName":"Company","name":"company","type":"string","default":""},{"displayName":"Country Code Name or ID","name":"countryCode","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCountries"},"default":""},{"displayName":"First Name","name":"firstName","type":"string","default":""},{"displayName":"Middle Name","name":"middleName","type":"string","default":""},{"displayName":"Last Name","name":"lastName","type":"string","default":""},{"displayName":"Line 1","name":"line1","type":"string","default":""},{"displayName":"Line 2","name":"line2","type":"string","default":""},{"displayName":"Locality","name":"locality","type":"string","default":""},{"displayName":"Region","name":"region","type":"string","default":""},{"displayName":"Zip Code","name":"zipCode","type":"string","default":""},{"displayName":"Zip Four","name":"zipFour","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""}]}]},{"displayName":"Order Items","name":"orderItemsUi","type":"fixedCollection","placeholder":"Add Order Item","typeOptions":{"multipleValues":true},"default":{},"displayOptions":{"show":{"resource":["ecommerceOrder"],"operation":["create"]}},"options":[{"name":"orderItemsValues","displayName":"Order Item","values":[{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Price","name":"price","type":"number","typeOptions":{"minValue":0},"default":0,"description":"Overridable price of the product, if not specified, the default will be used"},{"displayName":"Product ID","name":"product ID","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Quantity","name":"quantity","type":"number","typeOptions":{"minValue":1},"default":1}]}]},{"displayName":"Order ID","name":"orderId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["ecommerceOrder"]}},"default":""},{"displayName":"Order ID","name":"orderId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["ecommerceOrder"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["ecommerceOrder"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["ecommerceOrder"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["ecommerceOrder"]}},"options":[{"displayName":"Since","name":"since","type":"dateTime","default":"","description":"Date to start searching from"},{"displayName":"Until","name":"until","type":"dateTime","default":"","description":"Date to search to"},{"displayName":"Paid","name":"paid","type":"boolean","default":false},{"displayName":"Order","name":"order","type":"string","default":"","description":"Attribute to order items by"},{"displayName":"Contact ID","name":"contactId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Product ID","name":"productId","type":"number","typeOptions":{"minValue":0},"default":0}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["ecommerceProduct"]}},"options":[{"name":"Create","value":"create","description":"Create an ecommerce product","action":"Create an e-commerce product"},{"name":"Delete","value":"delete","description":"Delete an ecommerce product","action":"Delete an e-commerce product"},{"name":"Get","value":"get","description":"Get an ecommerce product","action":"Get an e-commerce product"},{"name":"Get Many","value":"getAll","description":"Retrieve many ecommerce products","action":"Get many e-commerce products"}],"default":"create"},{"displayName":"Product Name","name":"productName","type":"string","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceProduct"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["create"],"resource":["ecommerceProduct"]}},"options":[{"displayName":"Active","name":"active","type":"boolean","default":false},{"displayName":"Product Description","name":"productDesc","type":"string","default":""},{"displayName":"Product Price","name":"productPrice","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Product Short Desc","name":"productShortDesc","type":"string","default":""},{"displayName":"SKU","name":"sku","type":"string","default":""},{"displayName":"Subscription Only","name":"subscriptionOnly","type":"boolean","default":false}]},{"displayName":"Product ID","name":"productId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["ecommerceProduct"]}},"default":""},{"displayName":"Product ID","name":"productId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["ecommerceProduct"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["ecommerceProduct"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["ecommerceProduct"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["ecommerceProduct"]}},"options":[{"displayName":"Active","name":"active","type":"boolean","default":false}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["email"]}},"options":[{"name":"Create Record","value":"createRecord","description":"Create a record of an email sent to a contact","action":"Create a record of an email sent"},{"name":"Get Many","value":"getAll","description":"Retrieve many sent emails","action":"Get many emails"},{"name":"Send","value":"send","description":"Send Email","action":"Send an email"}],"default":"createRecord"},{"displayName":"Sent To Address","name":"sentToAddress","type":"string","required":true,"displayOptions":{"show":{"operation":["createRecord"],"resource":["email"]}},"default":""},{"displayName":"Sent From Address","name":"sentFromAddress","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["createRecord"],"resource":["email"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["createRecord"],"resource":["email"]}},"options":[{"displayName":"Clicked Date","name":"clickedDate","type":"dateTime","default":""},{"displayName":"Contact ID","name":"contactId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Headers","name":"headers","type":"string","default":""},{"displayName":"HTML Content","name":"htmlContent","type":"string","default":"","description":"Base64 encoded HTML"},{"displayName":"Opened Date","name":"openedDate","type":"dateTime","default":""},{"displayName":"Original Provider","name":"originalProvider","type":"options","options":[{"name":"Unknown","value":"UNKNOWN"},{"name":"Infusionsoft","value":"INFUSIONSOFT"},{"name":"Microsoft","value":"MICROSOFT"},{"name":"Google","value":"GOOGLE"}],"default":"UNKNOWN","description":"Provider that sent the email case insensitive, must be in list"},{"displayName":"Original Provider ID","name":"originalProviderId","type":"string","default":"","description":"Provider ID that sent the email, must be unique when combined with provider. If omitted a UUID without dashes is autogenerated for the record."},{"displayName":"Plain Content","name":"plainContent","type":"string","default":"","description":"Base64 encoded text"},{"displayName":"Provider Source ID","name":"providerSourceId","type":"string","default":"The email address of the synced email account that generated this message."},{"displayName":"Received Date","name":"receivedDate","type":"dateTime","default":""},{"displayName":"Sent Date","name":"sentDate","type":"dateTime","default":""},{"displayName":"Sent From Reply Address","name":"sentFromReplyAddress","type":"string","default":""},{"displayName":"Sent To Bcc Addresses","name":"sentToBccAddresses","type":"string","default":""},{"displayName":"Sent To CC Addresses","name":"sentToCCAddresses","type":"string","default":""},{"displayName":"Subject","name":"subject","type":"string","default":""}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["email"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["email"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["email"]}},"options":[{"displayName":"Contact ID","name":"contactId","type":"number","typeOptions":{"minValue":0},"default":0},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Since Sent Date","name":"sinceSentDate","type":"dateTime","default":"","description":"Emails sent since the provided date, must be present if untilDate is provided"},{"displayName":"Until Sent Date","name":"untilSentDate","type":"dateTime","default":"","description":"Email sent until the provided date"}]},{"displayName":"User Name or ID","name":"userId","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"getUsers"},"displayOptions":{"show":{"operation":["send"],"resource":["email"]}},"default":"","description":"The infusionsoft user to send the email on behalf of. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Contact IDs","name":"contactIds","type":"string","displayOptions":{"show":{"operation":["send"],"resource":["email"]}},"default":"","description":"Contact IDs to receive the email. Multiple can be added seperated by comma."},{"displayName":"Subject","name":"subject","type":"string","displayOptions":{"show":{"operation":["send"],"resource":["email"]}},"default":"","description":"The subject line of the email"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["send"],"resource":["email"]}},"options":[{"displayName":"Address Field","name":"addressField","type":"string","default":"","description":"Email field of each Contact record to address the email to, such as 'EmailAddress1', 'EmailAddress2', 'EmailAddress3', defaulting to the contact's primary email"},{"displayName":"HTML Content","name":"htmlContent","type":"string","default":"","description":"The HTML-formatted content of the email, encoded in Base64"},{"displayName":"Plain Content","name":"plainContent","type":"string","default":"","description":"The plain-text content of the email, encoded in Base64"}]},{"displayName":"Attachments","name":"attachmentsUi","placeholder":"Add Attachments","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"operation":["send"],"resource":["email"]}},"options":[{"name":"attachmentsValues","displayName":"Attachments Values","values":[{"displayName":"File Data","name":"fileData","type":"string","default":"","description":"The content of the attachment, encoded in Base64"},{"displayName":"File Name","name":"fileName","type":"string","default":"","description":"The filename of the attached file, including extension"}]},{"name":"attachmentsBinary","displayName":"Attachments Binary","values":[{"displayName":"Property","name":"property","type":"string","default":"","description":"Name of the binary properties which contain data which should be added to email as attachment"}]}],"default":{},"description":"Attachments to be sent with each copy of the email, maximum of 10 with size of 1MB each"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["file"]}},"options":[{"name":"Delete","value":"delete","description":"Delete a file","action":"Delete a file"},{"name":"Get Many","value":"getAll","description":"Retrieve many files","action":"Get many files"},{"name":"Upload","value":"upload","description":"Upload a file","action":"Upload a file"}],"default":"delete"},{"displayName":"Binary Data","name":"binaryData","type":"boolean","default":false,"displayOptions":{"show":{"operation":["upload"],"resource":["file"]}},"description":"Whether the data to upload should be taken from binary field"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"],"binaryData":[true]}},"description":"Name of the binary property which contains the data for the file to be uploaded"},{"displayName":"File Association","name":"fileAssociation","type":"options","options":[{"name":"Company","value":"company"},{"name":"Contact","value":"contact"},{"name":"User","value":"user"}],"required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"]}},"default":""},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"],"fileAssociation":["contact"]}},"default":""},{"displayName":"File Name","name":"fileName","type":"string","required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"],"binaryData":[false]}},"default":"","description":"The filename of the attached file, including extension"},{"displayName":"File Data","name":"fileData","type":"string","required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"],"binaryData":[false]}},"default":"","description":"The content of the attachment, encoded in Base64"},{"displayName":"Is Public","name":"isPublic","type":"boolean","default":false,"displayOptions":{"show":{"operation":["upload"],"resource":["file"]}}},{"displayName":"File ID","name":"fileId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["file"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["file"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["file"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["file"]}},"options":[{"displayName":"Contact ID","name":"contactId","type":"number","typeOptions":{"minValue":0},"default":0,"description":"Filter based on Contact ID, if user has permission to see Contact files"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Filter files based on name, with '*' preceding or following to indicate LIKE queries"},{"displayName":"Permission","name":"permission","type":"options","options":[{"name":"User","value":"user"},{"name":"Company","value":"company"},{"name":"Both","value":"both"}],"default":"both","description":"Filter based on the permission of files"},{"displayName":"Type","name":"type","type":"options","options":[{"name":"Application","value":"application"},{"name":"Attachment","value":"attachment"},{"name":"Contact","value":"contact"},{"name":"Digital Product","value":"digitalProduct"},{"name":"Fax","value":"fax"},{"name":"Funnel","value":"funnel"},{"name":"Hidden","value":"hidden"},{"name":"Image","value":"image"},{"name":"Import","value":"import"},{"name":"Logo Thumnail","value":"logoThumnail"},{"name":"Re Sampled Image","value":"reSampledImage"},{"name":"Style Cart","value":"styleCart"},{"name":"Template Thumnail","value":"templateThumnail"},{"name":"Ticket","value":"ticket"},{"name":"Webform","value":"webform"}],"default":"","description":"Filter based on the type of file"},{"displayName":"Viewable","name":"viewable","type":"options","options":[{"name":"Public","value":"public"},{"name":"Private","value":"private"},{"name":"Both","value":"both"}],"default":"both","description":"Include public or private files in response"}]}]

operations:
  [{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"contactNote","name":"Contact Note"},{"type":"resource","resource":"contactTag","name":"Contact Tag"},{"type":"resource","resource":"ecommerceOrder","name":"Ecommerce Order"},{"type":"resource","resource":"ecommerceProduct","name":"Ecommerce Product"},{"type":"resource","resource":"email","name":"Email"},{"type":"resource","resource":"file","name":"File"},{"type":"operation","operation":"create","name":"Create","action":"Create a company","resources":["company"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many companies","resources":["company"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"create","name":"Create","action":"Create a contact note","resources":["contactNote"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact note","resources":["contactNote"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact note","resources":["contactNote"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contact notes","resources":["contactNote"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact note","resources":["contactNote"]},{"type":"operation","operation":"create","name":"Create","action":"Create a contact tag","resources":["contactTag"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact tag","resources":["contactTag"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contact tags","resources":["contactTag"]},{"type":"operation","operation":"create","name":"Create","action":"Create an e-commerce order","resources":["ecommerceOrder"]},{"type":"operation","operation":"get","name":"Get","action":"Get an e-commerce order","resources":["ecommerceOrder"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an e-commerce order","resources":["ecommerceOrder"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many e-commerce orders","resources":["ecommerceOrder"]},{"type":"operation","operation":"create","name":"Create","action":"Create an e-commerce product","resources":["ecommerceProduct"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an e-commerce product","resources":["ecommerceProduct"]},{"type":"operation","operation":"get","name":"Get","action":"Get an e-commerce product","resources":["ecommerceProduct"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many e-commerce products","resources":["ecommerceProduct"]},{"type":"operation","operation":"createRecord","name":"Create Record","action":"Create a record of an email sent","resources":["email"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many emails","resources":["email"]},{"type":"operation","operation":"send","name":"Send","action":"Send an email","resources":["email"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a file","resources":["file"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many files","resources":["file"]},{"type":"operation","operation":"upload","name":"Upload","action":"Upload a file","resources":["file"]}]


node_type: keapTrigger
package_name: n8n-nodes-base
display_name: Keap Trigger
description: Starts the workflow when Infusionsoft events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"keapOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Keap Trigger node documentation
  description: Learn how to use the Keap Trigger node in n8n. Follow technical documentation to integrate Keap Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Keap Trigger node

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

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

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

properties_schema:
  [{"displayName":"Event Name or ID","name":"eventId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getEvents"},"default":"","required":true},{"displayName":"RAW Data","name":"rawData","type":"boolean","default":false,"description":"Whether to return the data exactly in the way it got received from the API"}]


node_type: kitemaker
package_name: n8n-nodes-base
display_name: Kitemaker
description: Consume the Kitemaker GraphQL API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"kitemakerApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Kitemaker node documentation
  description: Learn how to use the Kitemaker node in n8n. Follow technical documentation to integrate Kitemaker node into your workflows.
  contentType: [integration, reference]
  ---

  # Kitemaker node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"organization","name":"Organization"},{"type":"resource","resource":"space","name":"Space"},{"type":"resource","resource":"user","name":"User"},{"type":"resource","resource":"workItem","name":"Work Item"},{"type":"operation","operation":"get","name":"Get","action":"Get the logged-in user's organization","resources":["organization"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many spaces","resources":["space"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]},{"type":"operation","operation":"create","name":"Create","action":"Create a work item","resources":["workItem"]},{"type":"operation","operation":"get","name":"Get","action":"Get a work item","resources":["workItem"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many work items","resources":["workItem"]},{"type":"operation","operation":"update","name":"Update","action":"Update a work item","resources":["workItem"]}]


node_type: koBoToolbox
package_name: n8n-nodes-base
display_name: KoBoToolbox
description: Work with KoBoToolbox forms and submissions
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"koBoToolboxApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: KoboToolbox node documentation
  description: Learn how to use the KoboToolbox node in n8n. Follow technical documentation to integrate KoboToolbox node into your workflows.
  contentType: [integration, reference]
  ---

  # KoboToolbox node

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

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

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

  ## Operations

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

  ## Templates and examples

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

  ## Options

  ### Query Options

  The Query Submission operation supports query options:

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

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

  ### Submission options

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

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

  #### About reformatting

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

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

  When enabled, the reformatting:

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

  Here's a detailed example in JSON:

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

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

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


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

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

operations:
  [{"type":"resource","resource":"file","name":"File"},{"type":"resource","resource":"form","name":"Form"},{"type":"resource","resource":"hook","name":"Hook"},{"type":"resource","resource":"submission","name":"Submission"},{"type":"operation","operation":"get","name":"Get","action":"Get a form","resources":["form"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many forms","resources":["form"]},{"type":"operation","operation":"redeploy","name":"Redeploy","action":"Redeploy Current Form Version","resources":["form"]},{"type":"operation","operation":"get","name":"Get","action":"Get a hook","resources":["hook"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get Many hooks","resources":["hook"]},{"type":"operation","operation":"getLogs","name":"Logs","action":"Get Logs for a hook","resources":["hook"]},{"type":"operation","operation":"retryAll","name":"Retry All","action":"Retry All hooks","resources":["hook"]},{"type":"operation","operation":"retryOne","name":"Retry One","action":"Retry One hook","resources":["hook"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a submission","resources":["submission"]},{"type":"operation","operation":"get","name":"Get","action":"Get a submission","resources":["submission"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many submissions","resources":["submission"]},{"type":"operation","operation":"getValidation","name":"Get Validation Status","action":"Get the validation status for a submission","resources":["submission"]},{"type":"operation","operation":"setValidation","name":"Update Validation Status","action":"Update the validation status for a submission","resources":["submission"]},{"type":"operation","operation":"create","name":"Create","action":"Create a file","resources":["file"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a file","resources":["file"]},{"type":"operation","operation":"get","name":"Get","action":"Get a file content","resources":["file"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many files","resources":["file"]}]


node_type: koBoToolboxTrigger
package_name: n8n-nodes-base
display_name: KoBoToolbox Trigger
description: Process KoBoToolbox submissions
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"koBoToolboxApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: KoboToolbox Trigger node documentation
  description: Learn how to use the KoboToolbox Trigger node in n8n. Follow technical documentation to integrate KoboToolbox Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # KoboToolbox Trigger node

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

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

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

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

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

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


node_type: ldap
package_name: n8n-nodes-base
display_name: Ldap
description: Interact with LDAP servers
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"ldap","required":true,"testedBy":"ldapConnectionTest"}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: LDAP
  description: Documentation for the LDAP node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  ---

  # LDAP

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

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

  ## Operations

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

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

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

  ## Compare

  Configure this operation using these parameters:

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

  ## Create

  Configure this operation using these parameters:

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

  ## Delete

  Configure this operation using these parameters:

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

  ## Rename

  Configure this operation using these parameters:

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

  ## Search

  Configure this operation using these parameters:

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

  ### Search options

  You can also configure this operation using these options:

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

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

  ## Update

  Configure this operation using these parameters:

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

  ## Templates and examples

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

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


node_type: lemlist
package_name: n8n-nodes-base
display_name: Lemlist
description: Consume the Lemlist API
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"lemlistApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Lemlist node documentation
  description: Learn how to use the Lemlist node in n8n. Follow technical documentation to integrate Lemlist node into your workflows.
  contentType: [integration, reference]
  ---

  # Lemlist node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Activity","value":"activity"},{"name":"Campaign","value":"campaign"},{"name":"Lead","value":"lead"},{"name":"Team","value":"team"},{"name":"Unsubscribe","value":"unsubscribe"}],"default":"activity"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"getAll","options":[{"name":"Get Many","value":"getAll","action":"Get many activities"}],"displayOptions":{"show":{"resource":["activity"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":5,"description":"Max number of results to return","typeOptions":{"minValue":1,"maxValue":1000},"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}},"options":[{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getCampaigns"},"description":"ID of the campaign to retrieve activity for. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Type","name":"type","type":"options","default":"emailsOpened","description":"Type of activity to retrieve","options":[{"name":"Emails Bounced","value":"emailsBounced"},{"name":"Emails Clicked","value":"emailsClicked"},{"name":"Emails Opened","value":"emailsOpened"},{"name":"Emails Replied","value":"emailsReplied"},{"name":"Emails Send Failed","value":"emailsSendFailed"},{"name":"Emails Sent","value":"emailsSent"},{"name":"Emails Unsubscribed","value":"emailsUnsubscribed"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"getAll","options":[{"name":"Get Many","value":"getAll","action":"Get many campaigns"}],"displayOptions":{"show":{"resource":["campaign"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["campaign"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":5,"description":"Max number of results to return","typeOptions":{"minValue":1,"maxValue":1000},"displayOptions":{"show":{"resource":["campaign"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"create","options":[{"name":"Create","value":"create","action":"Create a lead"},{"name":"Delete","value":"delete","action":"Delete a lead"},{"name":"Get","value":"get","action":"Get a lead"},{"name":"Unsubscribe","value":"unsubscribe","action":"Unsubscribe a lead"}],"displayOptions":{"show":{"resource":["lead"]}}},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","required":true,"default":[],"typeOptions":{"loadOptionsMethod":"getCampaigns"},"description":"ID of the campaign to create the lead under. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["lead"],"operation":["create"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email of the lead to create","displayOptions":{"show":{"resource":["lead"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["create"]}},"options":[{"displayName":"Company Name","name":"companyName","type":"string","default":"","description":"Company name of the lead to create"},{"displayName":"Deduplicate","name":"deduplicate","type":"boolean","default":false,"description":"Whether to do not insert if this email is already present in another campaign"},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the lead to create"},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Last name of the lead to create"},{"displayName":"Icebreaker","name":"icebreaker","type":"string","default":"","description":"Icebreaker of the lead to create"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number of the lead to create"},{"displayName":"Picture URL","name":"picture","type":"string","default":"","description":"Picture URL of the lead to create"},{"displayName":"LinkedIn URL","name":"linkedinUrl","type":"string","default":"","description":"LinkedIn URL of the lead to create"}]},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","required":true,"default":[],"typeOptions":{"loadOptionsMethod":"getCampaigns"},"description":"ID of the campaign to remove the lead from. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email of the lead to delete","displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email of the lead to retrieve","displayOptions":{"show":{"resource":["lead"],"operation":["get"]}}},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","required":true,"default":[],"typeOptions":{"loadOptionsMethod":"getCampaigns"},"description":"ID of the campaign to unsubscribe the lead from. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["lead"],"operation":["unsubscribe"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email of the lead to unsubscribe","displayOptions":{"show":{"resource":["lead"],"operation":["unsubscribe"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"get","options":[{"name":"Get","value":"get","action":"Get a team"}],"displayOptions":{"show":{"resource":["team"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"add","options":[{"name":"Add","value":"add","action":"Add an email to an unsubscribe list"},{"name":"Delete","value":"delete","action":"Delete an email from an unsubscribe list"},{"name":"Get Many","value":"getAll","action":"Get many unsubscribed emails"}],"displayOptions":{"show":{"resource":["unsubscribe"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email to add to the unsubscribes","displayOptions":{"show":{"resource":["unsubscribe"],"operation":["add"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email to delete from the unsubscribes","displayOptions":{"show":{"resource":["unsubscribe"],"operation":["delete"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["unsubscribe"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":5,"description":"Max number of results to return","typeOptions":{"minValue":1,"maxValue":1000},"displayOptions":{"show":{"resource":["unsubscribe"],"operation":["getAll"],"returnAll":[false]}}}]

operations:
  [{"type":"resource","resource":"activity","name":"Activity"},{"type":"resource","resource":"campaign","name":"Campaign"},{"type":"resource","resource":"lead","name":"Lead"},{"type":"resource","resource":"team","name":"Team"},{"type":"resource","resource":"unsubscribe","name":"Unsubscribe"},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many activities","resources":["activity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many campaigns","resources":["campaign"]},{"type":"operation","operation":"create","name":"Create","action":"Create a lead","resources":["lead"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a lead","resources":["lead"]},{"type":"operation","operation":"get","name":"Get","action":"Get a lead","resources":["lead"]},{"type":"operation","operation":"unsubscribe","name":"Unsubscribe","action":"Unsubscribe a lead","resources":["lead"]},{"type":"operation","operation":"get","name":"Get","action":"Get a team","resources":["team"]},{"type":"operation","operation":"add","name":"Add","action":"Add an email to an unsubscribe list","resources":["unsubscribe"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an email from an unsubscribe list","resources":["unsubscribe"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many unsubscribed emails","resources":["unsubscribe"]}]


node_type: lemlistTrigger
package_name: n8n-nodes-base
display_name: Lemlist Trigger
description: Handle Lemlist events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"lemlistApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Lemlist Trigger node documentation
  description: Learn how to use the Lemlist Trigger node in n8n. Follow technical documentation to integrate Lemlist Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Lemlist Trigger node

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

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

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

  ## Events

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

properties_schema:
  [{"displayName":"Event","name":"event","type":"options","required":true,"default":"","options":[{"name":"*","value":"*"},{"name":"Emails Bounced","value":"emailsBounced"},{"name":"Emails Clicked","value":"emailsClicked"},{"name":"Emails Failed","value":"emailsFailed"},{"name":"Emails Interested","value":"emailsInterested"},{"name":"Emails Not Interested","value":"emailsNotInterested"},{"name":"Emails Opened","value":"emailsOpened"},{"name":"Emails Replied","value":"emailsReplied"},{"name":"Emails Send Failed","value":"emailsSendFailed"},{"name":"Emails Sent","value":"emailsSent"},{"name":"Emails Unsubscribed","value":"emailsUnsubscribed"}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Campaing Name or ID","name":"campaignId","type":"options","typeOptions":{"loadOptionsMethod":"getCampaigns"},"default":"","description":"We'll call this hook only for this campaignId. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Is First","name":"isFirst","type":"boolean","default":false,"description":"Whether to call this hook only the first time this activity happened"}]}]


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

  # Line node

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

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

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

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

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

  ## Operations

  * Notification
      * Sends notifications to users or groups

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Notification","value":"notification"}],"default":"notification"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["notification"]}},"options":[{"name":"Send","value":"send","description":"Sends notifications to users or groups","action":"Send a notification"}],"default":"send"},{"displayName":"Message","name":"message","required":true,"type":"string","displayOptions":{"show":{"operation":["send"],"resource":["notification"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["send"],"resource":["notification"]}},"options":[{"displayName":"Image","name":"imageUi","placeholder":"Add Image","type":"fixedCollection","typeOptions":{"multipleValues":false},"default":{},"options":[{"name":"imageValue","displayName":"Image","values":[{"displayName":"Binary Data","name":"binaryData","type":"boolean","default":false},{"displayName":"Image Full Size","name":"imageFullsize","type":"string","default":"","displayOptions":{"show":{"binaryData":[false]}},"description":"HTTP/HTTPS URL. Maximum size of 2048×2048px JPEG."},{"displayName":"Image Thumbnail","name":"imageThumbnail","type":"string","displayOptions":{"show":{"binaryData":[false]}},"default":"","description":"HTTP/HTTPS URL. Maximum size of 240×240px JPEG."},{"displayName":"Binary Property","name":"binaryProperty","type":"string","displayOptions":{"show":{"binaryData":[true]}},"default":"data","description":"Name of the property that holds the binary data"}]}]},{"displayName":"Notification Disabled","name":"notificationDisabled","type":"boolean","default":false,"description":"<p>true: The user doesn't receive a push notification when the message is sent.</p><p>false: The user receives a push notification when the message is sent</p>"},{"displayName":"Sticker","name":"stickerUi","placeholder":"Add Sticker","type":"fixedCollection","typeOptions":{"multipleValues":false},"default":{},"options":[{"name":"stickerValue","displayName":"Sticker","values":[{"displayName":"Sticker ID","name":"stickerId","type":"number","default":""},{"displayName":"Sticker Package ID","name":"stickerPackageId","type":"number","default":"","description":"Package ID"}]}]}]}]

operations:
  [{"type":"resource","resource":"notification","name":"Notification"},{"type":"operation","operation":"send","name":"Send","action":"Send a notification","resources":["notification"]}]

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


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

  # Linear node

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

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

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

  ## Operations

  * Issue
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"API Token","value":"apiToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"apiToken"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Issue","value":"issue"}],"default":"issue"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["issue"]}},"options":[{"name":"Create","value":"create","description":"Create an issue","action":"Create an issue"},{"name":"Delete","value":"delete","description":"Delete an issue","action":"Delete an issue"},{"name":"Get","value":"get","description":"Get an issue","action":"Get an issue"},{"name":"Get Many","value":"getAll","description":"Get many issues","action":"Get many issues"},{"name":"Update","value":"update","description":"Update an issue","action":"Update an issue"}],"default":"create"},{"displayName":"Team Name or ID","name":"teamId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}},"typeOptions":{"loadOptionsMethod":"getTeams"},"default":""},{"displayName":"Title","name":"title","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["create"]}},"options":[{"displayName":"Assignee Name or ID","name":"assigneeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"default":""},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Priority","name":"priorityId","type":"options","options":[{"name":"Urgent","value":1},{"name":"High","value":2},{"name":"Normal","value":3},{"name":"Low","value":4},{"name":"No Priority","value":0}],"default":0},{"displayName":"State Name or ID","name":"stateId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getStates"},"default":""}]},{"displayName":"Issue ID","name":"issueId","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["get","delete"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"displayOptions":{"show":{"resource":["issue"],"operation":["getAll"]}},"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":50,"typeOptions":{"minValue":1,"maxValue":300},"displayOptions":{"show":{"resource":["issue"],"operation":["getAll"],"returnAll":[false]}},"description":"Max number of results to return"},{"displayName":"Issue ID","name":"issueId","type":"string","required":true,"displayOptions":{"show":{"resource":["issue"],"operation":["update"]}},"default":""},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["update"]}},"options":[{"displayName":"Assignee Name or ID","name":"assigneeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getUsers"},"default":""},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Priority Name/ID","name":"priorityId","type":"options","options":[{"name":"Urgent","value":1},{"name":"High","value":2},{"name":"Medium","value":3},{"name":"Low","value":3},{"name":"No Priority","value":0}],"default":0},{"displayName":"State Name or ID","name":"stateId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getStates"},"default":""},{"displayName":"Team Name or ID","name":"teamId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTeams"},"default":""},{"displayName":"Title","name":"title","type":"string","default":""}]}]

operations:
  [{"type":"resource","resource":"issue","name":"Issue"},{"type":"operation","operation":"create","name":"Create","action":"Create an issue","resources":["issue"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an issue","resources":["issue"]},{"type":"operation","operation":"get","name":"Get","action":"Get an issue","resources":["issue"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many issues","resources":["issue"]},{"type":"operation","operation":"update","name":"Update","action":"Update an issue","resources":["issue"]}]

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


