# nodes

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

  # ConvertKit Trigger node

  [ConvertKit](https://www.convertkit.com/){:target=_blank .external-link} is a fully featured email marketing platform. Use ConvertKit to build an email list, send email broadcasts, automate sequences, create segments, and build landing pages.

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

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

properties_schema:
  [{"displayName":"Event","name":"event","type":"options","required":true,"default":"","description":"The events that can trigger the webhook and whether they are enabled","options":[{"name":"Form Subscribe","value":"formSubscribe"},{"name":"Link Click","value":"linkClick"},{"name":"Product Purchase","value":"productPurchase"},{"name":"Purchase Created","value":"purchaseCreate"},{"name":"Sequence Complete","value":"courseComplete"},{"name":"Sequence Subscribe","value":"courseSubscribe"},{"name":"Subscriber Activated","value":"subscriberActivate"},{"name":"Subscriber Unsubscribe","value":"subscriberUnsubscribe"},{"name":"Tag Add","value":"tagAdd"},{"name":"Tag Remove","value":"tagRemove"}]},{"displayName":"Form Name or ID","name":"formId","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":"getForms"},"required":true,"default":"","displayOptions":{"show":{"event":["formSubscribe"]}}},{"displayName":"Sequence Name or ID","name":"courseId","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":"getSequences"},"required":true,"default":"","displayOptions":{"show":{"event":["courseSubscribe","courseComplete"]}}},{"displayName":"Initiating Link","name":"link","type":"string","required":true,"default":"","description":"The URL of the initiating link","displayOptions":{"show":{"event":["linkClick"]}}},{"displayName":"Product ID","name":"productId","type":"string","required":true,"default":"","displayOptions":{"show":{"event":["productPurchase"]}}},{"displayName":"Tag Name or ID","name":"tagId","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":"getTags"},"required":true,"default":"","displayOptions":{"show":{"event":["tagAdd","tagRemove"]}}}]


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

  # Copper node

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

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

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

  ## Operations

  * Company
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Customer Source
      * Get All
  * Lead
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Opportunity
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Person
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Project
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Task
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * User
      * Get All

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Company","value":"company"},{"name":"Customer Source","value":"customerSource"},{"name":"Lead","value":"lead"},{"name":"Opportunity","value":"opportunity"},{"name":"Person","value":"person"},{"name":"Project","value":"project"},{"name":"Task","value":"task"},{"name":"User","value":"user"}],"default":"company"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["company"]}},"options":[{"name":"Create","value":"create","action":"Create a company"},{"name":"Delete","value":"delete","action":"Delete a company"},{"name":"Get","value":"get","action":"Get a company"},{"name":"Get Many","value":"getAll","action":"Get many companies"},{"name":"Update","value":"update","action":"Update a company"}],"default":"create"},{"displayName":"Name","name":"name","description":"Name of the company to create","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["company"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"options":[{"displayName":"Address","name":"address","placeholder":"Add Address Fields","type":"fixedCollection","default":{},"options":[{"displayName":"Address Fields","name":"addressFields","values":[{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postal_code","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":"","description":"ISO 3166 alpha-2 country code"}]}]},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description of the company to create"},{"displayName":"Email Domain","name":"email_domain","type":"string","default":""},{"displayName":"Phone Numbers","name":"phone_numbers","placeholder":"Add Phone Number","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Phone Fields","name":"phoneFields","values":[{"displayName":"Number","name":"number","type":"string","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]}]},{"displayName":"Company ID","name":"companyId","description":"ID of the company to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["company"],"operation":["delete"]}}},{"displayName":"Company ID","name":"companyId","description":"ID of the company to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["company"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["company"],"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":["company"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filterFields","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["getAll"]}},"options":[{"displayName":"Country","name":"country","type":"options","options":[{"name":"Afghanistan","value":"AF"},{"name":"Åland Islands","value":"AX"},{"name":"Albania","value":"AL"},{"name":"Algeria","value":"DZ"},{"name":"American Samoa","value":"AS"},{"name":"Andorra","value":"AD"},{"name":"Angola","value":"AO"},{"name":"Anguilla","value":"AI"},{"name":"Antarctica","value":"AQ"},{"name":"Antigua and Barbuda","value":"AG"},{"name":"Argentina","value":"AR"},{"name":"Armenia","value":"AM"},{"name":"Aruba","value":"AW"},{"name":"Australia","value":"AU"},{"name":"Austria","value":"AT"},{"name":"Azerbaijan","value":"AZ"},{"name":"Bahamas (the)","value":"BS"},{"name":"Bahrain","value":"BH"},{"name":"Bangladesh","value":"BD"},{"name":"Barbados","value":"BB"},{"name":"Belarus","value":"BY"},{"name":"Belgium","value":"BE"},{"name":"Belize","value":"BZ"},{"name":"Benin","value":"BJ"},{"name":"Bermuda","value":"BM"},{"name":"Bhutan","value":"BT"},{"name":"Bolivia (Plurinational State of)","value":"BO"},{"name":"Bonaire, Sint Eustatius and Saba","value":"BQ"},{"name":"Bosnia and Herzegovina","value":"BA"},{"name":"Botswana","value":"BW"},{"name":"Bouvet Island","value":"BV"},{"name":"Brazil","value":"BR"},{"name":"British Indian Ocean Territory (the)","value":"IO"},{"name":"Brunei Darussalam","value":"BN"},{"name":"Bulgaria","value":"BG"},{"name":"Burkina Faso","value":"BF"},{"name":"Burundi","value":"BI"},{"name":"Cabo Verde","value":"CV"},{"name":"Cambodia","value":"KH"},{"name":"Cameroon","value":"CM"},{"name":"Canada","value":"CA"},{"name":"Cayman Islands (the)","value":"KY"},{"name":"Central African Republic (the)","value":"CF"},{"name":"Chad","value":"TD"},{"name":"Chile","value":"CL"},{"name":"China","value":"CN"},{"name":"Christmas Island","value":"CX"},{"name":"Cocos (Keeling) Islands (the)","value":"CC"},{"name":"Colombia","value":"CO"},{"name":"Comoros (the)","value":"KM"},{"name":"Congo (the Democratic Republic of the)","value":"CD"},{"name":"Congo (the)","value":"CG"},{"name":"Cook Islands (the)","value":"CK"},{"name":"Costa Rica","value":"CR"},{"name":"Côte d'Ivoire","value":"CI"},{"name":"Croatia","value":"HR"},{"name":"Cuba","value":"CU"},{"name":"Curaçao","value":"CW"},{"name":"Cyprus","value":"CY"},{"name":"Czechia","value":"CZ"},{"name":"Denmark","value":"DK"},{"name":"Djibouti","value":"DJ"},{"name":"Dominica","value":"DM"},{"name":"Dominican Republic (the)","value":"DO"},{"name":"Ecuador","value":"EC"},{"name":"Egypt","value":"EG"},{"name":"El Salvador","value":"SV"},{"name":"Equatorial Guinea","value":"GQ"},{"name":"Eritrea","value":"ER"},{"name":"Estonia","value":"EE"},{"name":"Ethiopia","value":"ET"},{"name":"Falkland Islands (the) [Malvinas]","value":"FK"},{"name":"Faroe Islands (the)","value":"FO"},{"name":"Fiji","value":"FJ"},{"name":"Finland","value":"FI"},{"name":"France","value":"FR"},{"name":"French Guiana","value":"GF"},{"name":"French Polynesia","value":"PF"},{"name":"French Southern Territories (the)","value":"TF"},{"name":"Gabon","value":"GA"},{"name":"Gambia (the)","value":"GM"},{"name":"Georgia","value":"GE"},{"name":"Germany","value":"DE"},{"name":"Ghana","value":"GH"},{"name":"Gibraltar","value":"GI"},{"name":"Greece","value":"GR"},{"name":"Greenland","value":"GL"},{"name":"Grenada","value":"GD"},{"name":"Guadeloupe","value":"GP"},{"name":"Guam","value":"GU"},{"name":"Guatemala","value":"GT"},{"name":"Guernsey","value":"GG"},{"name":"Guinea","value":"GN"},{"name":"Guinea-Bissau","value":"GW"},{"name":"Guyana","value":"GY"},{"name":"Haiti","value":"HT"},{"name":"Heard Island and McDonald Islands","value":"HM"},{"name":"Holy See (the)","value":"VA"},{"name":"Honduras","value":"HN"},{"name":"Hong Kong","value":"HK"},{"name":"Hungary","value":"HU"},{"name":"Iceland","value":"IS"},{"name":"India","value":"IN"},{"name":"Indonesia","value":"ID"},{"name":"Iran (Islamic Republic of)","value":"IR"},{"name":"Iraq","value":"IQ"},{"name":"Ireland","value":"IE"},{"name":"Isle of Man","value":"IM"},{"name":"Israel","value":"IL"},{"name":"Italy","value":"IT"},{"name":"Jamaica","value":"JM"},{"name":"Japan","value":"JP"},{"name":"Jersey","value":"JE"},{"name":"Jordan","value":"JO"},{"name":"Kazakhstan","value":"KZ"},{"name":"Kenya","value":"KE"},{"name":"Kiribati","value":"KI"},{"name":"Korea (the Democratic People's Republic of)","value":"KP"},{"name":"Korea (the Republic of)","value":"KR"},{"name":"Kuwait","value":"KW"},{"name":"Kyrgyzstan","value":"KG"},{"name":"Lao People's Democratic Republic (the)","value":"LA"},{"name":"Latvia","value":"LV"},{"name":"Lebanon","value":"LB"},{"name":"Lesotho","value":"LS"},{"name":"Liberia","value":"LR"},{"name":"Libya","value":"LY"},{"name":"Liechtenstein","value":"LI"},{"name":"Lithuania","value":"LT"},{"name":"Luxembourg","value":"LU"},{"name":"Macao","value":"MO"},{"name":"Macedonia (the former Yugoslav Republic of)","value":"MK"},{"name":"Madagascar","value":"MG"},{"name":"Malawi","value":"MW"},{"name":"Malaysia","value":"MY"},{"name":"Maldives","value":"MV"},{"name":"Mali","value":"ML"},{"name":"Malta","value":"MT"},{"name":"Marshall Islands (the)","value":"MH"},{"name":"Martinique","value":"MQ"},{"name":"Mauritania","value":"MR"},{"name":"Mauritius","value":"MU"},{"name":"Mayotte","value":"YT"},{"name":"Mexico","value":"MX"},{"name":"Micronesia (Federated States of)","value":"FM"},{"name":"Moldova (the Republic of)","value":"MD"},{"name":"Monaco","value":"MC"},{"name":"Mongolia","value":"MN"},{"name":"Montenegro","value":"ME"},{"name":"Montserrat","value":"MS"},{"name":"Morocco","value":"MA"},{"name":"Mozambique","value":"MZ"},{"name":"Myanmar","value":"MM"},{"name":"Namibia","value":"NA"},{"name":"Nauru","value":"NR"},{"name":"Nepal","value":"NP"},{"name":"Netherlands (the)","value":"NL"},{"name":"New Caledonia","value":"NC"},{"name":"New Zealand","value":"NZ"},{"name":"Nicaragua","value":"NI"},{"name":"Niger (the)","value":"NE"},{"name":"Nigeria","value":"NG"},{"name":"Niue","value":"NU"},{"name":"Norfolk Island","value":"NF"},{"name":"Northern Mariana Islands (the)","value":"MP"},{"name":"Norway","value":"NO"},{"name":"Oman","value":"OM"},{"name":"Pakistan","value":"PK"},{"name":"Palau","value":"PW"},{"name":"Palestine, State of","value":"PS"},{"name":"Panama","value":"PA"},{"name":"Papua New Guinea","value":"PG"},{"name":"Paraguay","value":"PY"},{"name":"Peru","value":"PE"},{"name":"Philippines (the)","value":"PH"},{"name":"Pitcairn","value":"PN"},{"name":"Poland","value":"PL"},{"name":"Portugal","value":"PT"},{"name":"Puerto Rico","value":"PR"},{"name":"Qatar","value":"QA"},{"name":"Réunion","value":"RE"},{"name":"Romania","value":"RO"},{"name":"Russian Federation (the)","value":"RU"},{"name":"Rwanda","value":"RW"},{"name":"Saint Barthélemy","value":"BL"},{"name":"Saint Helena, Ascension and Tristan da Cunha","value":"SH"},{"name":"Saint Kitts and Nevis","value":"KN"},{"name":"Saint Lucia","value":"LC"},{"name":"Saint Martin (French part)","value":"MF"},{"name":"Saint Pierre and Miquelon","value":"PM"},{"name":"Saint Vincent and the Grenadines","value":"VC"},{"name":"Samoa","value":"WS"},{"name":"San Marino","value":"SM"},{"name":"Sao Tome and Principe","value":"ST"},{"name":"Saudi Arabia","value":"SA"},{"name":"Senegal","value":"SN"},{"name":"Serbia","value":"RS"},{"name":"Seychelles","value":"SC"},{"name":"Sierra Leone","value":"SL"},{"name":"Singapore","value":"SG"},{"name":"Sint Maarten (Dutch part)","value":"SX"},{"name":"Slovakia","value":"SK"},{"name":"Slovenia","value":"SI"},{"name":"Solomon Islands","value":"SB"},{"name":"Somalia","value":"SO"},{"name":"South Africa","value":"ZA"},{"name":"South Georgia and the South Sandwich Islands","value":"GS"},{"name":"South Sudan","value":"SS"},{"name":"Spain","value":"ES"},{"name":"Sri Lanka","value":"LK"},{"name":"Sudan (the)","value":"SD"},{"name":"Suriname","value":"SR"},{"name":"Svalbard and Jan Mayen","value":"SJ"},{"name":"Swaziland","value":"SZ"},{"name":"Sweden","value":"SE"},{"name":"Switzerland","value":"CH"},{"name":"Syrian Arab Republic","value":"SY"},{"name":"Taiwan (Province of China)","value":"TW"},{"name":"Tajikistan","value":"TJ"},{"name":"Tanzania, United Republic of","value":"TZ"},{"name":"Thailand","value":"TH"},{"name":"Timor-Leste","value":"TL"},{"name":"Togo","value":"TG"},{"name":"Tokelau","value":"TK"},{"name":"Tonga","value":"TO"},{"name":"Trinidad and Tobago","value":"TT"},{"name":"Tunisia","value":"TN"},{"name":"Turkey","value":"TR"},{"name":"Turkmenistan","value":"TM"},{"name":"Turks and Caicos Islands (the)","value":"TC"},{"name":"Tuvalu","value":"TV"},{"name":"Uganda","value":"UG"},{"name":"Ukraine","value":"UA"},{"name":"United Arab Emirates (the)","value":"AE"},{"name":"United Kingdom of Great Britain and Northern Ireland (the)","value":"GB"},{"name":"United States Minor Outlying Islands (the)","value":"UM"},{"name":"United States of America (the)","value":"US"},{"name":"Uruguay","value":"UY"},{"name":"Uzbekistan","value":"UZ"},{"name":"Vanuatu","value":"VU"},{"name":"Venezuela (Bolivarian Republic of)","value":"VE"},{"name":"Viet Nam","value":"VN"},{"name":"Virgin Islands (British)","value":"VG"},{"name":"Virgin Islands (U.S.)","value":"VI"},{"name":"Wallis and Futuna","value":"WF"},{"name":"Western Sahara","value":"EH"},{"name":"Yemen","value":"YE"},{"name":"Zambia","value":"ZM"},{"name":"Zimbabwe","value":"ZW"}],"default":"","description":"Country of the company to filter by"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the company to filter by"}]},{"displayName":"Company ID","name":"companyId","description":"ID of the company to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["company"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["update"]}},"options":[{"displayName":"Address","name":"address","placeholder":"Add Address Fields","type":"fixedCollection","default":{},"options":[{"displayName":"Address Fields","name":"addressFields","values":[{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postal_code","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":"","description":"ISO 3166 alpha-2 country code"}]}]},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description to set for the company"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name to set for the company"},{"displayName":"Phone Numbers","name":"phone_numbers","placeholder":"Add Phone Number","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Phone Fields","name":"phoneFields","values":[{"displayName":"Number","name":"number","type":"string","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["customerSource"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many customer sources"}],"default":"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":["customerSource"],"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":["customerSource"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["lead"]}},"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":"Get Many","value":"getAll","action":"Get many leads"},{"name":"Update","value":"update","action":"Update a lead"}],"default":"create"},{"displayName":"Name","name":"name","description":"Name of the lead to create","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"resource":["lead"],"operation":["create"]}},"options":[{"displayName":"Address","name":"address","placeholder":"Add Address Fields","type":"fixedCollection","default":{},"options":[{"displayName":"Address Fields","name":"addressFields","values":[{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postal_code","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":"","description":"ISO 3166 alpha-2 country code"}]}]},{"displayName":"Email","name":"email","placeholder":"Add Email","type":"fixedCollection","default":{},"options":[{"displayName":"Email Fields","name":"emailFields","values":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]},{"displayName":"Phone Numbers","name":"phone_numbers","placeholder":"Add Phone Number","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Phone Fields","name":"phoneFields","values":[{"displayName":"Number","name":"number","type":"string","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]}]},{"displayName":"Lead ID","name":"leadId","description":"ID of the lead to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}}},{"displayName":"Lead ID","name":"leadId","description":"ID of the lead to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["lead"],"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":["lead"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filterFields","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["getAll"]}},"options":[{"displayName":"Country","name":"country","type":"string","default":"","description":"Name of the country to filter by"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the lead to filter by"}]},{"displayName":"Lead ID","name":"leadId","description":"ID of the lead to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["update"]}},"options":[{"displayName":"Address","name":"address","placeholder":"Add Address Fields","type":"fixedCollection","default":{},"options":[{"displayName":"Address Fields","name":"addressFields","values":[{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postal_code","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":"","description":"ISO 3166 alpha-2 country code"}]}]},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description to set for the lead"},{"displayName":"Email","name":"email","placeholder":"Add Email","type":"fixedCollection","default":{},"options":[{"displayName":"Email Fields","name":"emailFields","values":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name to set for the lead"},{"displayName":"Phone Numbers","name":"phone_numbers","placeholder":"Add Phone Number","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Phone Fields","name":"phoneFields","values":[{"displayName":"Number","name":"number","type":"string","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["opportunity"]}},"options":[{"name":"Create","value":"create","action":"Create an opportunity"},{"name":"Delete","value":"delete","action":"Delete an opportunity"},{"name":"Get","value":"get","action":"Get an opportunity"},{"name":"Get Many","value":"getAll","action":"Get many opportunities"},{"name":"Update","value":"update","action":"Update an opportunity"}],"default":"create"},{"displayName":"Name","name":"name","description":"Name of the opportunity to create","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}}},{"displayName":"Customer Source ID","name":"customerSourceId","type":"string","default":"","description":"ID of the customer source that generated this opportunity","displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}}},{"displayName":"Primary Contact ID","name":"primaryContactId","type":"string","default":"","description":"ID of the primary company associated with this opportunity","displayOptions":{"show":{"resource":["opportunity"],"operation":["create"]}}},{"displayName":"Opportunity ID","name":"opportunityId","description":"ID of the opportunity to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["delete"]}}},{"displayName":"Opportunity ID","name":"opportunityId","description":"ID of the opportunity to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["opportunity"],"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":["opportunity"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filterFields","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"]}},"options":[{"displayName":"Company IDs","name":"company_ids","type":"string","default":"","description":"Comma-separated IDs of the primary companies to filter by"},{"displayName":"Customer Source IDs","name":"customer_source_ids","type":"string","default":"","description":"Comma-separated IDs of the customer sources to filter by"}]},{"displayName":"Opportunity ID","name":"opportunityId","description":"ID of the opportunity to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["update"]}},"options":[{"displayName":"Customer Source ID","name":"customer_source_id","type":"string","default":"","description":"ID of the primary company associated with this opportunity"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name to set for the opportunity"},{"displayName":"Primary Contact ID","name":"primary_contact_id","type":"string","default":"","description":"ID of the customer source that generated this opportunity"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["person"]}},"options":[{"name":"Create","value":"create","action":"Create a person"},{"name":"Delete","value":"delete","action":"Delete a person"},{"name":"Get","value":"get","action":"Get a person"},{"name":"Get Many","value":"getAll","action":"Get many people"},{"name":"Update","value":"update","action":"Update a person"}],"default":"create"},{"displayName":"Name","name":"name","description":"Name of the person to create","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["person"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["person"],"operation":["create"]}},"options":[{"displayName":"Address","name":"address","placeholder":"Add Address Fields","type":"fixedCollection","default":{},"options":[{"displayName":"Address Fields","name":"addressFields","values":[{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postal_code","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":"","description":"ISO 3166 alpha-2 country code"}]}]},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description to set for the person"},{"displayName":"Email Domain","name":"email_domain","type":"string","default":""},{"displayName":"Emails","name":"emails","placeholder":"Add Email","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Email Fields","name":"emailFields","values":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]},{"displayName":"Phone Numbers","name":"phone_numbers","placeholder":"Add Phone Number","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Phone Fields","name":"phoneFields","values":[{"displayName":"Number","name":"number","type":"string","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]}]},{"displayName":"Person ID","name":"personId","description":"ID of the person to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["person"],"operation":["delete"]}}},{"displayName":"Person ID","name":"personId","description":"ID of the person to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["person"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["person"],"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":["person"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filterFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["person"],"operation":["getAll"]}},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the person to filter by"}]},{"displayName":"Person ID","name":"personId","description":"ID of the person to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["person"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["person"],"operation":["update"]}},"options":[{"displayName":"Address","name":"address","placeholder":"Add Address Fields","type":"fixedCollection","default":{},"options":[{"displayName":"Address Fields","name":"addressFields","values":[{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"State","name":"state","type":"string","default":""},{"displayName":"Postal Code","name":"postal_code","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":"","description":"ISO 3166 alpha-2 country code"}]}]},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description to set for the person"},{"displayName":"Email Domain","name":"email_domain","type":"string","default":""},{"displayName":"Emails","name":"emails","placeholder":"Add Email","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Email Fields","name":"emailFields","values":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name to set for the person"},{"displayName":"Phone Numbers","name":"phone_numbers","placeholder":"Add Phone Number","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Phone Fields","name":"phoneFields","values":[{"displayName":"Number","name":"number","type":"string","default":""},{"displayName":"Category","name":"category","type":"string","default":""}]}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["project"]}},"options":[{"name":"Create","value":"create","action":"Create a project"},{"name":"Delete","value":"delete","action":"Delete a project"},{"name":"Get","value":"get","action":"Get a project"},{"name":"Get Many","value":"getAll","action":"Get many projects"},{"name":"Update","value":"update","action":"Update a project"}],"default":"create"},{"displayName":"Name","name":"name","description":"Name of the project to create","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["project"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["project"],"operation":["create"]}},"options":[{"displayName":"Assignee ID","name":"assignee_id","type":"string","default":"","description":"ID of the user who will own the project to create"},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description of the project to create"},{"displayName":"Status","name":"status","type":"options","default":"Open","options":[{"name":"Completed","value":"Completed"},{"name":"Open","value":"Open"}]}]},{"displayName":"Project ID","name":"projectId","description":"ID of the project to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["project"],"operation":["delete"]}}},{"displayName":"Project ID","name":"projectId","description":"ID of the project to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["project"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["project"],"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":["project"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filterFields","type":"collection","default":{},"placeholder":"Add Filter","displayOptions":{"show":{"resource":["project"],"operation":["getAll"]}},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the project to filter by"}]},{"displayName":"Project ID","name":"projectId","description":"ID of the project to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["project"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["project"],"operation":["update"]}},"options":[{"displayName":"Assignee ID","name":"assignee_id","type":"string","default":"","description":"ID of the user who will own the project"},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description to set for the project"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name to set for the project"},{"displayName":"Status","name":"status","type":"options","default":"Open","options":[{"name":"Completed","value":"Completed"},{"name":"Open","value":"Open"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["task"]}},"options":[{"name":"Create","value":"create","action":"Create a task"},{"name":"Delete","value":"delete","action":"Delete a task"},{"name":"Get","value":"get","action":"Get a task"},{"name":"Get Many","value":"getAll","action":"Get many tasks"},{"name":"Update","value":"update","action":"Update a task"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"options":[{"displayName":"Assignee ID","name":"assignee_id","type":"string","default":"","description":"ID of the user who will own the task to create"},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description of the task to create"},{"displayName":"Priority","name":"priority","type":"options","default":"High","options":[{"name":"High","value":"High"},{"name":"None","value":"None"}]},{"displayName":"Status","name":"status","type":"options","default":"Open","options":[{"name":"Completed","value":"Completed"},{"name":"Open","value":"Open"}]}]},{"displayName":"Task ID","name":"taskId","description":"ID of the task to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["delete"]}}},{"displayName":"Task ID","name":"taskId","description":"ID of the task to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["task"],"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":["task"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filterFields","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"options":[{"displayName":"Assignee IDs","name":"assignee_ids","type":"string","default":"","description":"Comma-separated IDs of assignee IDs to filter by"},{"displayName":"Project IDs","name":"project_ids","type":"string","default":"","description":"Comma-separated IDs of project IDs to filter by"}]},{"displayName":"Task ID","name":"taskId","description":"ID of the task to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"options":[{"displayName":"Assignee ID","name":"assignee_id","type":"string","default":"","description":"ID of the user who will own the task"},{"displayName":"Details","name":"details","type":"string","default":"","description":"Description to set for the task"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name to set for the task"},{"displayName":"Priority","name":"priority","type":"options","default":"High","options":[{"name":"High","value":"High"},{"name":"None","value":"None"}]},{"displayName":"Status","name":"status","type":"options","default":"Open","options":[{"name":"Completed","value":"Completed"},{"name":"Open","value":"Open"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many users"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":5,"description":"Max number of results to return","typeOptions":{"minValue":1,"maxValue":1000},"displayOptions":{"show":{"resource":["user"],"operation":["getAll"],"returnAll":[false]}}}]

operations:
  [{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"customerSource","name":"Customer Source"},{"type":"resource","resource":"lead","name":"Lead"},{"type":"resource","resource":"opportunity","name":"Opportunity"},{"type":"resource","resource":"person","name":"Person"},{"type":"resource","resource":"project","name":"Project"},{"type":"resource","resource":"task","name":"Task"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"create","name":"Create","action":"Create a company","resources":["company"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete 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":"getAll","name":"Get Many","action":"Get many customer sources","resources":["customerSource"]},{"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 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 person","resources":["person"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a person","resources":["person"]},{"type":"operation","operation":"get","name":"Get","action":"Get a person","resources":["person"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many people","resources":["person"]},{"type":"operation","operation":"update","name":"Update","action":"Update a person","resources":["person"]},{"type":"operation","operation":"create","name":"Create","action":"Create a project","resources":["project"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a project","resources":["project"]},{"type":"operation","operation":"get","name":"Get","action":"Get a project","resources":["project"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many projects","resources":["project"]},{"type":"operation","operation":"update","name":"Update","action":"Update a project","resources":["project"]},{"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"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]}]


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

  # Copper Trigger node

  [Copper](https://www.copper.com/){:target=_blank .external-link} is a CRM that focuses on strong integration with Google Workspace. It's mainly targeted towards small and medium-sized businesses.

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"required":true,"default":"","options":[{"name":"Company","value":"company"},{"name":"Lead","value":"lead"},{"name":"Opportunity","value":"opportunity"},{"name":"Person","value":"person"},{"name":"Project","value":"project"},{"name":"Task","value":"task"}],"description":"The resource which will fire the event"},{"displayName":"Event","name":"event","type":"options","required":true,"default":"","options":[{"name":"Delete","value":"delete","description":"An existing record is removed"},{"name":"New","value":"new","description":"A new record is created"},{"name":"Update","value":"update","description":"Any field in the existing entity record is changed"}],"description":"The event to listen to"}]

operations:
  [{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"lead","name":"Lead"},{"type":"resource","resource":"opportunity","name":"Opportunity"},{"type":"resource","resource":"person","name":"Person"},{"type":"resource","resource":"project","name":"Project"},{"type":"resource","resource":"task","name":"Task"}]


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

  # Cortex node

  Use the Cortex node to automate work in Cortex, and integrate Cortex with other applications. n8n has built-in support for a wide range of Cortex features, including executing analyzers, and responders, as well as getting job details.

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

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

  ## Operations

  * Analyzer
      * Execute Analyzer
  * Job
      * Get job details
      * Get job report
  * Responder
      * Execute Responder

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Analyzer","value":"analyzer"},{"name":"Job","value":"job"},{"name":"Responder","value":"responder"}],"default":"analyzer","description":"Choose a resource","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"description":"Choose an operation","displayOptions":{"show":{"resource":["analyzer"]}},"default":"execute","options":[{"name":"Execute","value":"execute","description":"Execute Analyzer","action":"Execute an analyzer"}]},{"displayName":"Analyzer Type Name or ID","name":"analyzer","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"loadActiveAnalyzers"},"displayOptions":{"show":{"resource":["analyzer"],"operation":["execute"]}},"description":"Choose the analyzer. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","default":""},{"displayName":"Observable Type Name or ID","name":"observableType","type":"options","required":true,"displayOptions":{"show":{"resource":["analyzer"],"operation":["execute"]},"hide":{"analyzer":[""]}},"typeOptions":{"loadOptionsMethod":"loadObservableOptions","loadOptionsDependsOn":["analyzer"]},"default":"","description":"Choose the observable type. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Observable Value","name":"observableValue","type":"string","required":true,"displayOptions":{"show":{"resource":["analyzer"],"operation":["execute"]},"hide":{"observableType":["file"],"analyzer":[""]}},"default":"","description":"Enter the observable value"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"observableType":["file"],"resource":["analyzer"],"operation":["execute"]}},"description":"Name of the binary property to which to write the data of the read file"},{"displayName":"TLP","name":"tlp","type":"options","displayOptions":{"show":{"resource":["analyzer"],"operation":["execute"]},"hide":{"observableType":[""],"analyzer":[""]}},"options":[{"name":"White","value":0},{"name":"Green","value":1},{"name":"Amber","value":2},{"name":"Red","value":3}],"default":2,"description":"The TLP of the analyzed observable"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["analyzer"],"operation":["execute"]}},"options":[{"displayName":"Force","name":"force","type":"boolean","default":false,"description":"Whether to force bypassing the cache"},{"displayName":"Timeout (Seconds)","name":"timeout","type":"number","default":3,"description":"Timeout to wait for the report in case it is not available at the time the query was made"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"description":"Choose an operation","displayOptions":{"show":{"resource":["responder"]}},"options":[{"name":"Execute","value":"execute","description":"Execute Responder","action":"Execute a responder"}],"default":"execute"},{"displayName":"Responder Type Name or ID","name":"responder","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"loadActiveResponders"},"default":"","displayOptions":{"show":{"resource":["responder"]}},"description":"Choose the responder. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Entity Type Name or ID","name":"entityType","type":"options","required":true,"displayOptions":{"show":{"resource":["responder"]}},"typeOptions":{"loadOptionsMethod":"loadDataTypeOptions","loadOptionsDependsOn":["responder"]},"default":"","description":"Choose the Data type. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"JSON Parameters","name":"jsonObject","type":"boolean","default":false,"description":"Choose between providing JSON object or seperated attributes","displayOptions":{"show":{"resource":["responder"]}}},{"displayName":"Entity Object (JSON)","name":"objectData","type":"string","required":true,"displayOptions":{"show":{"resource":["responder"],"jsonObject":[true]}},"default":""},{"displayName":"Parameters","name":"parameters","type":"fixedCollection","placeholder":"Add Parameter","options":[{"displayName":"Case Attributes","name":"values","values":[{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the case"},{"displayName":"Flag","name":"flag","type":"boolean","default":false,"description":"Flag of the case default=false"},{"displayName":"Owner","name":"owner","type":"string","default":"","description":"User who owns the case. This is automatically set to current user when status is set to InProgress."},{"displayName":"Severity","name":"severity","type":"options","default":2,"options":[{"name":"Low","value":1},{"name":"Medium","value":2},{"name":"High","value":3}],"description":"Severity of the case. Default=Medium."},{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","description":"Date and time of the begin of the case default=now"},{"displayName":"Tags","name":"tags","type":"string","default":"","placeholder":"tag1,tag2,..."},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title of the case"},{"displayName":"TLP","name":"tlp","type":"options","default":2,"options":[{"name":"White","value":0},{"name":"Green","value":1},{"name":"Amber","value":2},{"name":"Red","value":3}],"description":"Traffic Light Protocol (TLP). Default=Amber."}]}],"typeOptions":{"loadOptionsDependsOn":["entityType"]},"displayOptions":{"show":{"resource":["responder"],"jsonObject":[false],"entityType":["case"]},"hide":{"entityType":["","alert","case_artifact","case_task","case_task_log"]}},"default":{}},{"displayName":"Parameters","name":"parameters","type":"fixedCollection","placeholder":"Add Parameter","options":[{"displayName":"Alert Attributes","name":"values","values":[{"displayName":"Artifacts","name":"artifacts","type":"fixedCollection","placeholder":"Add an artifact","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add an Artifact"},"default":[],"options":[{"displayName":"Artifact","name":"artifactValues","values":[{"displayName":"Binary Property","name":"binaryProperty","type":"string","displayOptions":{"show":{"dataType":["file"]}},"default":"data"},{"displayName":"Data","name":"data","type":"string","displayOptions":{"hide":{"dataType":["file"]}},"default":""},{"displayName":"Data Type","name":"dataType","type":"options","default":"","options":[{"name":"Domain","value":"domain"},{"name":"File","value":"file"},{"name":"Filename","value":"filename"},{"name":"Fqdn","value":"fqdn"},{"name":"Hash","value":"hash"},{"name":"IP","value":"ip"},{"name":"Mail","value":"mail"},{"name":"Mail Subject","value":"mail_subject"},{"name":"Other","value":"other"},{"name":"Regexp","value":"regexp"},{"name":"Registry","value":"registry"},{"name":"Uri Path","value":"uri_path"},{"name":"URL","value":"url"},{"name":"User Agent","value":"user-agent"}]},{"displayName":"Message","name":"message","type":"string","default":""},{"displayName":"Tags","name":"tags","type":"string","default":""}]}]},{"displayName":"Date","name":"date","type":"dateTime","default":"","description":"Date and time when the alert was raised default=now"},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the alert"},{"displayName":"Follow","name":"follow","type":"boolean","default":false},{"displayName":"Severity","name":"severity","type":"options","default":2,"options":[{"name":"Low","value":1},{"name":"Medium","value":2},{"name":"High","value":3}],"description":"Severity of the case. Default=Medium."},{"displayName":"Source","name":"source","type":"string","default":"","description":"Source of the alert"},{"displayName":"SourceRef","name":"sourceRef","type":"string","default":"","description":"Source reference of the alert"},{"displayName":"Status","name":"status","type":"options","default":"New","options":[{"name":"New","value":"New"},{"name":"Updated","value":"Updated"},{"name":"Ignored","value":"Ignored"},{"name":"Imported","value":"Imported"}],"description":"Status of the alert. Default=New."},{"displayName":"Tags","name":"tags","type":"string","placeholder":"tag1,tag2,...","default":""},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title of the alert"},{"displayName":"TLP","name":"tlp","type":"options","default":2,"options":[{"name":"White","value":0},{"name":"Green","value":1},{"name":"Amber","value":2},{"name":"Red","value":3}],"description":"Traffic Light Protocol (TLP). Default=Amber."},{"displayName":"Type","name":"type","type":"string","default":"","description":"Type of the alert"}]}],"typeOptions":{"loadOptionsDependsOn":["entityType"]},"displayOptions":{"show":{"resource":["responder"],"jsonObject":[false],"entityType":["alert"]},"hide":{"responder":[""],"entityType":["","case","case_artifact","case_task","case_task_log"]}},"default":{}},{"displayName":"Parameters","name":"parameters","type":"fixedCollection","placeholder":"Add Parameter","options":[{"displayName":"Observable Attributes","name":"values","values":[{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","displayOptions":{"show":{"dataType":["file"]}},"description":"Name of the binary property which contains the attachement data"},{"displayName":"Data","name":"data","type":"string","default":"","displayOptions":{"hide":{"dataType":["file"]}}},{"displayName":"DataType","name":"dataType","type":"options","default":"","options":[{"name":"Domain","value":"domain"},{"name":"File","value":"file"},{"name":"Filename","value":"filename"},{"name":"Fqdn","value":"fqdn"},{"name":"Hash","value":"hash"},{"name":"IP","value":"ip"},{"name":"Mail","value":"mail"},{"name":"Mail Subject","value":"mail_subject"},{"name":"Other","value":"other"},{"name":"Regexp","value":"regexp"},{"name":"Registry","value":"registry"},{"name":"Uri Path","value":"uri_path"},{"name":"URL","value":"url"},{"name":"User Agent","value":"user-agent"}]},{"displayName":"IOC","name":"ioc","type":"boolean","default":false,"description":"Whether the observable is an IOC (Indicator of compromise)"},{"displayName":"Message","name":"message","type":"string","default":""},{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","description":"Date and time of the begin of the case default=now"},{"displayName":"Status","name":"status","type":"options","default":"","options":[{"name":"Ok","value":"Ok"},{"name":"Deleted","value":"Deleted"}],"description":"Status of the observable (Ok or Deleted) default=Ok"},{"displayName":"TLP","name":"tlp","type":"options","default":2,"options":[{"name":"White","value":0},{"name":"Green","value":1},{"name":"Amber","value":2},{"name":"Red","value":3}],"description":"Traffic Light Protocol (TLP). Default=Amber."}]}],"typeOptions":{"loadOptionsDependsOn":["entityType"]},"displayOptions":{"show":{"resource":["responder"],"jsonObject":[false],"entityType":["case_artifact"]},"hide":{"responder":[""],"entityType":["","case","alert","case_task","case_task_log"]}},"default":{}},{"displayName":"Parameters","name":"parameters","type":"fixedCollection","placeholder":"Add Parameter","options":[{"displayName":"Task Attributes","name":"values","values":[{"displayName":"Title","name":"title","type":"string","default":"","description":"Title of the task"},{"displayName":"Status","name":"status","type":"options","default":"Waiting","options":[{"name":"Waiting","value":"Waiting"},{"name":"InProgress","value":"InProgress"},{"name":"Completed","value":"Completed"},{"name":"Cancel","value":"Cancel"}]},{"displayName":"Flag","name":"flag","type":"boolean","default":false}]}],"typeOptions":{"loadOptionsDependsOn":["entityType"]},"displayOptions":{"show":{"resource":["responder"],"jsonObject":[false],"entityType":["case_task"]},"hide":{"responder":[""],"entityType":["","case","alert","case_artifact","case_task_log"]}},"default":{}},{"displayName":"Parameters","name":"parameters","type":"fixedCollection","placeholder":"Add Parameter","options":[{"displayName":"Log Attributes","name":"values","values":[{"displayName":"Message","name":"message","type":"string","default":""},{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","description":"Date and time of the begin of the case default=now"},{"displayName":"Status","name":"status","type":"options","required":true,"default":"","options":[{"name":"Ok","value":"Ok"},{"name":"Deleted","value":"Deleted"}]}]}],"typeOptions":{"loadOptionsDependsOn":["entityType"]},"displayOptions":{"show":{"resource":["responder"],"jsonObject":[false],"entityType":["case_task_log"]},"hide":{"responder":[""],"entityType":["","case","alert","case_artifact","case_task"]}},"default":{}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"description":"Choose an operation","required":true,"displayOptions":{"show":{"resource":["job"]}},"options":[{"name":"Get","value":"get","description":"Get job details","action":"Get a job"},{"name":"Report","value":"report","description":"Get job report","action":"Get a job report"}],"default":"get"},{"displayName":"Job ID","name":"jobId","type":"string","required":true,"displayOptions":{"show":{"resource":["job"],"operation":["get","report"]}},"default":"","description":"ID of the job"}]

operations:
  [{"type":"resource","resource":"analyzer","name":"Analyzer"},{"type":"resource","resource":"job","name":"Job"},{"type":"resource","resource":"responder","name":"Responder"},{"type":"operation","operation":"execute","name":"Execute","action":"Execute an analyzer","resources":["analyzer"]},{"type":"operation","operation":"execute","name":"Execute","action":"Execute a responder","resources":["responder"]},{"type":"operation","operation":"get","name":"Get","action":"Get a job","resources":["job"]},{"type":"operation","operation":"report","name":"Report","action":"Get a job report","resources":["job"]}]


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

  # CrateDB node

  Use the CrateDB node to automate work in CrateDB, and integrate CrateDB with other applications. n8n has built-in support for a wide range of CrateDB features, including executing, inserting, and updating rows in the database.

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

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

  ## Operations

  * Execute an SQL query
  * Insert rows in database
  * Update rows in database

  ## Templates and examples

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

  ## Node reference

  ### Specify a column's data type

  To specify a column's data type, append the column name with `:type`, where `type` is the data type you want for the column. For example, if you want to specify the type `int` for the column **id** and type `text` for the column **name**, you can use the following snippet in the **Columns** field: `id:int,name:text`.

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Execute Query","value":"executeQuery","description":"Execute an SQL query","action":"Execute a SQL query"},{"name":"Insert","value":"insert","description":"Insert rows in database","action":"Insert rows in database"},{"name":"Update","value":"update","description":"Update rows in database","action":"Update rows in database"}],"default":"insert"},{"displayName":"Query","name":"query","type":"string","noDataExpression":true,"typeOptions":{"editor":"sqlEditor","rows":5,"sqlDialect":"PostgreSQL"},"displayOptions":{"show":{"operation":["executeQuery"]}},"default":"","placeholder":"SELECT id, name FROM product WHERE quantity > $1 AND price <= $2","required":true,"description":"The SQL query to execute. You can use n8n expressions or $1 and $2 in conjunction with query parameters."},{"displayName":"Schema","name":"schema","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"doc","required":true,"description":"Name of the schema the table belongs to"},{"displayName":"Table","name":"table","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"","required":true,"description":"Name of the table in which to insert data to"},{"displayName":"Columns","name":"columns","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"","placeholder":"id,name,description","description":"Comma-separated list of the properties which should used as columns for the new rows"},{"displayName":"Schema","name":"schema","type":"string","displayOptions":{"show":{"operation":["update"]}},"default":"doc","required":true,"description":"Name of the schema the table belongs to"},{"displayName":"Table","name":"table","type":"string","displayOptions":{"show":{"operation":["update"]}},"default":"","required":true,"description":"Name of the table in which to update data in"},{"displayName":"Update Key","name":"updateKey","type":"string","displayOptions":{"show":{"operation":["update"]}},"default":"id","required":true,"description":"Comma-separated list of the properties which decides which rows in the database should be updated. Normally that would be \"id\"."},{"displayName":"Columns","name":"columns","type":"string","displayOptions":{"show":{"operation":["update"]}},"default":"","placeholder":"name,description","description":"Comma-separated list of the properties which should used as columns for rows to update"},{"displayName":"Return Fields","name":"returnFields","type":"string","displayOptions":{"show":{"operation":["insert","update"]}},"default":"*","description":"Comma-separated list of the fields that the operation will return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Mode","name":"mode","type":"options","options":[{"name":"Independently","value":"independently","description":"Execute each query independently"},{"name":"Multiple Queries","value":"multiple","description":"<b>Default</b>. Sends multiple queries at once to database."}],"default":"multiple","description":"The way queries should be sent to database. Can be used in conjunction with <b>Continue on Fail</b>. See <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.cratedb/\">the docs</a> for more examples."},{"displayName":"Query Parameters","name":"queryParams","type":"string","displayOptions":{"show":{"/operation":["executeQuery"]}},"default":"","placeholder":"quantity,price","description":"Comma-separated list of properties which should be used as query parameters"}]}]


node_type: cron
package_name: n8n-nodes-base
display_name: Cron
description: Triggers the workflow at a specific time
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":"Trigger Times","name":"triggerTimes","type":"fixedCollection","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Time"},"default":{},"description":"Triggers for the workflow","placeholder":"Add Cron Time","options":[{"name":"item","displayName":"Item","values":[{"displayName":"Mode","name":"mode","type":"options","options":[{"name":"Every Minute","value":"everyMinute"},{"name":"Every Hour","value":"everyHour"},{"name":"Every Day","value":"everyDay"},{"name":"Every Week","value":"everyWeek"},{"name":"Every Month","value":"everyMonth"},{"name":"Every X","value":"everyX"},{"name":"Custom","value":"custom"}],"default":"everyDay","description":"How often to trigger."},{"displayName":"Hour","name":"hour","type":"number","typeOptions":{"minValue":0,"maxValue":23},"displayOptions":{"hide":{"mode":["custom","everyHour","everyMinute","everyX"]}},"default":14,"description":"The hour of the day to trigger (24h format)"},{"displayName":"Minute","name":"minute","type":"number","typeOptions":{"minValue":0,"maxValue":59},"displayOptions":{"hide":{"mode":["custom","everyMinute","everyX"]}},"default":0,"description":"The minute of the day to trigger"},{"displayName":"Day of Month","name":"dayOfMonth","type":"number","displayOptions":{"show":{"mode":["everyMonth"]}},"typeOptions":{"minValue":1,"maxValue":31},"default":1,"description":"The day of the month to trigger"},{"displayName":"Weekday","name":"weekday","type":"options","displayOptions":{"show":{"mode":["everyWeek"]}},"options":[{"name":"Monday","value":"1"},{"name":"Tuesday","value":"2"},{"name":"Wednesday","value":"3"},{"name":"Thursday","value":"4"},{"name":"Friday","value":"5"},{"name":"Saturday","value":"6"},{"name":"Sunday","value":"0"}],"default":"1","description":"The weekday to trigger"},{"displayName":"Cron Expression","name":"cronExpression","type":"string","displayOptions":{"show":{"mode":["custom"]}},"default":"* * * * * *","description":"Use custom cron expression. Values and ranges as follows:<ul><li>Seconds: 0-59</li><li>Minutes: 0 - 59</li><li>Hours: 0 - 23</li><li>Day of Month: 1 - 31</li><li>Months: 0 - 11 (Jan - Dec)</li><li>Day of Week: 0 - 6 (Sun - Sat)</li></ul>"},{"displayName":"Value","name":"value","type":"number","typeOptions":{"minValue":0,"maxValue":1000},"displayOptions":{"show":{"mode":["everyX"]}},"default":2,"description":"All how many X minutes/hours it should trigger"},{"displayName":"Unit","name":"unit","type":"options","displayOptions":{"show":{"mode":["everyX"]}},"options":[{"name":"Minutes","value":"minutes"},{"name":"Hours","value":"hours"}],"default":"hours","description":"If it should trigger all X minutes or hours"}]}]}]


node_type: crowdDev
package_name: n8n-nodes-base
display_name: crowd.dev
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"crowdDevApi","required":true}]
updated_at: 2025-06-12 12:00:45
description:
  crowd.dev is an open-source suite of community and data tools built to unlock community-led growth for your organization.

documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: crowd.dev node documentation
  description: Learn how to use the crowd.dev node in n8n. Follow technical documentation to integrate crowd.dev node into your workflows.
  contentType: [integration, reference]
  ---

  # crowd.dev node

  Use the crowd.dev node to automate work in crowd.dev and integrate crowd.dev with other applications. n8n has built-in support for a wide range of crowd.dev features, which includes creating, updating, and deleting members, notes, organizations, and tasks.

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

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

  ## Operations

  * Activity
  	* Create or Update with a Member
  	* Create
  * Automation
  	* Create
  	* Destroy
  	* Find
  	* List
  	* Update
  * Member
  	* Create or Update
  	* Delete
  	* Find
  	* Update
  * Note
  	* Create
  	* Delete
  	* Find
  	* Update
  * Organization
  	* Create
  	* Delete
  	* Find
  	* Update
  * Task
  	* Create
  	* Delete
  	* Find
  	* Update

  ## Templates and examples

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

  ## Related resources

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

  Refer to [crowd.dev's documentation](https://docs.crowd.dev/reference/getting-started-with-crowd-dev-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,"default":"activity","placeholder":"Resourcee","options":[{"name":"Activity","value":"activity"},{"name":"Automation","value":"automation"},{"name":"Member","value":"member"},{"name":"Note","value":"note"},{"name":"Organization","value":"organization"},{"name":"Task","value":"task"}]},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["activity"]}},"noDataExpression":true,"default":"createWithMember","options":[{"name":"Create or Update with a Member","value":"createWithMember","description":"Create or update an activity with a member","action":"Create or update an activity with a member","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/activity/with-member"}}},{"name":"Create","value":"createForMember","description":"Create an activity for a member","action":"Create an activity for a member","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/activity"}}}]},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["member"]}},"noDataExpression":true,"default":"find","options":[{"name":"Create or Update","value":"createOrUpdate","description":"Create or update a member","action":"Create or update a member","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/member"}}},{"name":"Delete","value":"delete","description":"Delete a member","action":"Delete a member","routing":{"request":{"method":"DELETE","url":"=/member"}}},{"name":"Find","value":"find","description":"Find a member","action":"Find a member","routing":{"request":{"method":"GET","url":"=/member/{{$parameter[\"id\"]}}"}}},{"name":"Update","value":"update","description":"Update a member","action":"Update a member","routing":{"send":{"preSend":[null]},"request":{"method":"PUT","url":"=/member/{{$parameter[\"id\"]}}"}}}]},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["note"]}},"noDataExpression":true,"default":"find","options":[{"name":"Create","value":"create","description":"Create a note","action":"Create a note","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/note"}}},{"name":"Delete","value":"delete","description":"Delete a note","action":"Delete a note","routing":{"request":{"method":"DELETE","url":"=/note"}}},{"name":"Find","value":"find","description":"Find a note","action":"Find a note","routing":{"request":{"method":"GET","url":"=/note/{{$parameter[\"id\"]}}"}}},{"name":"Update","value":"update","description":"Update a note","action":"Update a note","routing":{"send":{"preSend":[null]},"request":{"method":"PUT","url":"=/note/{{$parameter[\"id\"]}}"}}}]},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["organization"]}},"noDataExpression":true,"default":"find","options":[{"name":"Create","value":"create","description":"Create an organization","action":"Create an organization","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/organization"}}},{"name":"Delete","value":"delete","description":"Delete an organization","action":"Delete an organization","routing":{"request":{"method":"DELETE","url":"=/organization"}}},{"name":"Find","value":"find","description":"Find an organization","action":"Find an organization","routing":{"request":{"method":"GET","url":"=/organization/{{$parameter[\"id\"]}}"}}},{"name":"Update","value":"update","description":"Update an organization","action":"Update an organization","routing":{"send":{"preSend":[null]},"request":{"method":"PUT","url":"=/organization/{{$parameter[\"id\"]}}"}}}]},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["task"]}},"noDataExpression":true,"default":"find","options":[{"name":"Create","value":"create","description":"Create a task","action":"Create a task","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/task"}}},{"name":"Delete","value":"delete","description":"Delete a task","action":"Delete a task","routing":{"request":{"method":"DELETE","url":"=/task"}}},{"name":"Find","value":"find","description":"Find a task","action":"Find a task","routing":{"request":{"method":"GET","url":"=/task/{{$parameter[\"id\"]}}"}}},{"name":"Update","value":"update","description":"Update a task","action":"Update a task","routing":{"send":{"preSend":[null]},"request":{"method":"PUT","url":"=/task/{{$parameter[\"id\"]}}"}}}]},{"displayName":"Operation","name":"operation","type":"options","displayOptions":{"show":{"resource":["automation"]}},"noDataExpression":true,"default":"list","options":[{"name":"Create","value":"create","description":"Create a new automation for the tenant","action":"Create a new automation for the tenant","routing":{"send":{"preSend":[null]},"request":{"method":"POST","url":"/automation"}}},{"name":"Destroy","value":"destroy","description":"Destroy an existing automation for the tenant","action":"Destroy an existing automation for the tenant","routing":{"request":{"method":"DELETE","url":"=/automation/{{$parameter[\"id\"]}}"}}},{"name":"Find","value":"find","description":"Get an existing automation data for the tenant","action":"Get an existing automation data for the tenant","routing":{"request":{"method":"GET","url":"=/automation/{{$parameter[\"id\"]}}"}}},{"name":"List","value":"list","description":"Get all existing automation data for tenant","action":"Get all existing automation data for tenant","routing":{"request":{"method":"GET","url":"/automation"}}},{"name":"Update","value":"update","description":"Updates an existing automation for the tenant","action":"Updates an existing automation for the tenant","routing":{"send":{"preSend":[null]},"request":{"method":"PUT","url":"=/automation/{{$parameter[\"id\"]}}"}}}]},{"displayName":"Username","name":"username","type":"fixedCollection","typeOptions":{"multipleValues":true},"required":true,"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Platform","description":"Platform name (e.g twitter, github, etc)","name":"key","type":"string","required":true,"default":""},{"displayName":"Username","description":"Username at the specified Platform","name":"value","type":"string","required":true,"default":""}]}],"displayOptions":{"show":{"resource":["activity"],"operation":["createWithMember"]}}},{"displayName":"displayName","name":"displayName","description":"UI friendly name of the member","type":"string","default":"","displayOptions":{"show":{"resource":["activity"],"operation":["createWithMember"]}}},{"displayName":"Emails","name":"emails","description":"Email addresses of the member","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""}]}],"displayOptions":{"show":{"resource":["activity"],"operation":["createWithMember"]}}},{"displayName":"Joined At","name":"joinedAt","description":"Date of joining the community","type":"dateTime","default":"","displayOptions":{"show":{"resource":["activity"],"operation":["createWithMember"]}}},{"displayName":"Member","name":"member","description":"The ID of the member that performed the activity","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"operation":["createForMember"]}}},{"displayName":"Type","name":"type","description":"Type of activity","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"]}}},{"displayName":"Timestamp","name":"timestamp","description":"Date and time when the activity took place","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["activity"]}}},{"displayName":"Platform","name":"platform","description":"Platform on which the activity took place","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"]}}},{"displayName":"Source ID","name":"sourceId","description":"The ID of the activity in the platform (e.g. the ID of the message in Discord)","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"]}}},{"displayName":"Additional Options","name":"additionalOptions","type":"collection","displayOptions":{"show":{"resource":["activity"]}},"default":{},"placeholder":"Add Option","options":[{"displayName":"Title","name":"title","description":"Title of the activity","type":"string","default":""},{"displayName":"Body","name":"body","description":"Body of the activity","type":"string","default":""},{"displayName":"Channel","name":"channel","description":"Channel of the activity","type":"string","default":""},{"displayName":"Source Parent ID","name":"sourceParentId","description":"The ID of the parent activity in the platform (e.g. the ID of the parent message in Discord)","type":"string","default":""}]},{"displayName":"ID","name":"id","type":"string","required":true,"default":"","routing":{"send":{"type":"query","property":"ids[]"}},"description":"The ID of the member","displayOptions":{"show":{"resource":["member"],"operation":["delete","find","update"]}}},{"displayName":"Platform","name":"platform","description":"Platform for which to check member existence","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["member"],"operation":["createOrUpdate","update"]}}},{"displayName":"Username","name":"username","description":"Username of the member in platform","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["member"],"operation":["createOrUpdate","update"]}}},{"displayName":"Additional Options","name":"additionalOptions","type":"collection","displayOptions":{"show":{"resource":["member"],"operation":["createOrUpdate","update"]}},"default":{},"placeholder":"Add Option","options":[{"displayName":"Display Name","name":"displayName","description":"UI friendly name of the member","type":"string","default":""},{"displayName":"Emails","name":"emails","description":"Email addresses of the member","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""}]}]},{"displayName":"Joined At","name":"joinedAt","description":"Date of joining the community","type":"dateTime","default":""},{"displayName":"Organizations","name":"organizations","description":"Organizations associated with the member. Each element in the array is the name of the organization, or an organization object. If the organization does not exist, it will be created.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Name","name":"name","description":"The name of the organization","type":"string","required":true,"default":""},{"displayName":"Url","name":"url","description":"The URL of the organization","type":"string","default":""},{"displayName":"Description","name":"description","description":"A short description of the organization","type":"string","typeOptions":{"rows":3},"default":""},{"displayName":"Logo","name":"logo","description":"A URL for logo of the organization","type":"string","default":""},{"displayName":"Employees","name":"employees","description":"The number of employees of the organization","type":"number","default":""}]}]},{"displayName":"Tags","name":"tags","description":"Tags associated with the member. Each element in the array is the ID of the tag.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Tag","name":"tag","type":"string","default":""}]}]},{"displayName":"Tasks","name":"tasks","description":"Tasks associated with the member. Each element in the array is the ID of the task.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Task","name":"task","type":"string","default":""}]}]},{"displayName":"Notes","name":"notes","description":"Notes associated with the member. Each element in the array is the ID of the note.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Note","name":"note","type":"string","default":""}]}]},{"displayName":"Activities","name":"activities","description":"Activities associated with the member. Each element in the array is the ID of the activity.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Activity","name":"activity","type":"string","default":""}]}]}]},{"displayName":"ID","name":"id","type":"string","required":true,"default":"","routing":{"send":{"type":"query","property":"ids[]"}},"description":"The ID of the note","displayOptions":{"show":{"resource":["note"],"operation":["delete","find","update"]}}},{"displayName":"Body","name":"body","description":"The body of the note","type":"string","typeOptions":{"rows":4},"default":"","displayOptions":{"show":{"resource":["note"],"operation":["create","update"]}}},{"displayName":"ID","name":"id","type":"string","required":true,"default":"","routing":{"send":{"type":"query","property":"ids[]"}},"description":"The ID of the organization","displayOptions":{"show":{"resource":["organization"],"operation":["delete","find","update"]}}},{"displayName":"Name","name":"name","description":"The name of the organization","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["organization"],"operation":["create","update"]}}},{"displayName":"Additional Options","name":"additionalOptions","type":"collection","displayOptions":{"show":{"resource":["organization"],"operation":["create","update"]}},"default":{},"placeholder":"Add Option","options":[{"displayName":"Url","name":"url","description":"The URL of the organization","type":"string","default":""},{"displayName":"Description","name":"description","description":"A short description of the organization","type":"string","typeOptions":{"rows":3},"default":""},{"displayName":"Logo","name":"logo","description":"A URL for logo of the organization","type":"string","default":""},{"displayName":"Employees","name":"employees","description":"The number of employees of the organization","type":"number","default":""},{"displayName":"Members","name":"members","description":"Members associated with the organization. Each element in the array is the ID of the member.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Member","name":"member","type":"string","default":""}]}]}]},{"displayName":"ID","name":"id","type":"string","required":true,"default":"","routing":{"send":{"type":"query","property":"ids[]"}},"description":"The ID of the task","displayOptions":{"show":{"resource":["task"],"operation":["delete","find","update"]}}},{"displayName":"Additional Options","name":"additionalOptions","type":"collection","displayOptions":{"show":{"resource":["task"],"operation":["create","update"]}},"default":{},"placeholder":"Add Option","options":[{"displayName":"Name","name":"name","description":"The name of the task","type":"string","default":""},{"displayName":"Body","name":"body","description":"The body of the task","type":"string","typeOptions":{"rows":4},"default":""},{"displayName":"Status","name":"status","description":"The status of the task","type":"string","default":""},{"displayName":"Members","name":"members","description":"Members associated with the task. Each element in the array is the ID of the member.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Member","name":"member","type":"string","default":""}]}]},{"displayName":"Activities","name":"activities","description":"Activities associated with the task. Each element in the array is the ID of the activity.","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"displayName":"Item Choice","name":"itemChoice","values":[{"displayName":"Activity","name":"activity","type":"string","default":""}]}]},{"displayName":"Assigneess","name":"assigneess","description":"Users assigned with the task. Each element in the array is the ID of the user.","type":"string","default":""}]},{"displayName":"ID","name":"id","description":"The ID of the automation","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["automation"],"operation":["destroy","find","update"]}}},{"displayName":"Trigger","name":"trigger","description":"What will trigger an automation","type":"options","required":true,"default":"new_activity","options":[{"name":"New Activity","value":"new_activity"},{"name":"New Member","value":"new_member"}],"displayOptions":{"show":{"resource":["automation"],"operation":["create","update"]}}},{"displayName":"URL","name":"url","description":"URL to POST webhook data to","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["automation"],"operation":["create","update"]}}}]

operations:
  [{"type":"resource","resource":"activity","name":"Activity"},{"type":"resource","resource":"automation","name":"Automation"},{"type":"resource","resource":"member","name":"Member"},{"type":"resource","resource":"note","name":"Note"},{"type":"resource","resource":"organization","name":"Organization"},{"type":"resource","resource":"task","name":"Task"},{"type":"operation","operation":"createWithMember","name":"Create or Update with a Member","action":"Create or update an activity with a member","resources":["activity"]},{"type":"operation","operation":"createForMember","name":"Create","action":"Create an activity for a member","resources":["activity"]},{"type":"operation","operation":"createOrUpdate","name":"Create or Update","action":"Create or update a member","resources":["member"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a member","resources":["member"]},{"type":"operation","operation":"find","name":"Find","action":"Find a member","resources":["member"]},{"type":"operation","operation":"update","name":"Update","action":"Update a member","resources":["member"]},{"type":"operation","operation":"create","name":"Create","action":"Create a note","resources":["note"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a note","resources":["note"]},{"type":"operation","operation":"find","name":"Find","action":"Find a note","resources":["note"]},{"type":"operation","operation":"update","name":"Update","action":"Update a note","resources":["note"]},{"type":"operation","operation":"create","name":"Create","action":"Create an organization","resources":["organization"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an organization","resources":["organization"]},{"type":"operation","operation":"find","name":"Find","action":"Find an organization","resources":["organization"]},{"type":"operation","operation":"update","name":"Update","action":"Update an organization","resources":["organization"]},{"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":"find","name":"Find","action":"Find a task","resources":["task"]},{"type":"operation","operation":"update","name":"Update","action":"Update a task","resources":["task"]},{"type":"operation","operation":"create","name":"Create","action":"Create a new automation for the tenant","resources":["automation"]},{"type":"operation","operation":"destroy","name":"Destroy","action":"Destroy an existing automation for the tenant","resources":["automation"]},{"type":"operation","operation":"find","name":"Find","action":"Get an existing automation data for the tenant","resources":["automation"]},{"type":"operation","operation":"list","name":"List","action":"Get all existing automation data for tenant","resources":["automation"]},{"type":"operation","operation":"update","name":"Update","action":"Updates an existing automation for the tenant","resources":["automation"]}]


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

  # crowd.dev Trigger node

  Use the crowd.dev Trigger node to respond to events in [crowd.dev](https://www.crowd.dev/){:target=_blank .external-link} and integrate crowd.dev with other applications. n8n has built-in support for a wide range of crowd.dev events, including new activities and new members.

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

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

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

  ## Events

  * New Activity
  * New Member

  ## Related resources

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

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

  Refer to [crowd.dev's documentation](https://docs.crowd.dev/reference/getting-started-with-crowd-dev-api){:target=_blank .external-link} for more information about the service.

properties_schema:
  [{"displayName":"Trigger","name":"trigger","description":"What will trigger an automation","type":"options","required":true,"default":"new_activity","options":[{"name":"New Activity","value":"new_activity"},{"name":"New Member","value":"new_member"}]}]


node_type: crypto
package_name: n8n-nodes-base
display_name: Crypto
description: Provide cryptographic utilities
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: Crypto
  description: Documentation for the Crypto node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Crypto

  Use the Crypto node to encrypt data in workflows.

  ## Actions

  * [**Generate** a random string](#generate-parameters)
  * [**Hash** a text or file](#hash-parameters) in a specified format
  * [**Hmac** a text or file](#hmac-parameters) in a specified format
  * [**Sign** a string](#sign-parameters) using a private key

  ## Node parameters

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

  Node parameters depend on the action you select.

  ### Generate parameters

  * **Property Name**: Enter the name of the property to write the random string to.
  * **Type**: Select the encoding type to use to generate the string. Choose from:
  	* **ASCII**
  	* **BASE64**
  	* **HEX**
  	* **UUID**

  ### Hash parameters

  * **Type**: Select the hash type to use. Choose from:
  	* **MD5**
  	* **SHA256**
  	* **SHA3-256**
  	* **SHA3-384**
  	* **SHA3-512**
  	* **SHA385**
  	* **SHA512**
  * **Binary File**: Turn this parameter on if the data you want to hash is from a binary file.
  	* **Value**: If you turn off **Binary File**, enter the value you want to hash.
  	* **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to hash.
  * **Property Name**: Enter the name of the property you want to write the hash to.
  * **Encoding**: Select the encoding type to use. Choose from:
  	* **BASE64**
  	* **HEX**

  ### Hmac parameters

  * **Binary File**: Turn this parameter on if the data you want to encrypt is from a binary file.
  	* **Value**: If you turn off **Binary File**, enter the value you want to encrypt.
  	* **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to encrypt.
  * **Type**: Select the encryption type to use. Choose from:
  	* **MD5**
  	* **SHA256**
  	* **SHA3-256**
  	* **SHA3-384**
  	* **SHA3-512**
  	* **SHA385**
  	* **SHA512**
  * **Property Name**: Enter the name of the property you want to write the hash to.
  * **Secret**: Enter the secret or secret key used for decoding.
  * **Encoding**: Select the encoding type to use. Choose from:
  	* **BASE64**
  	* **HEX**

  ### Sign parameters

  * **Value**: Enter the value you want to sign.
  * **Property Name**: Enter the name of the property you want to write the signed value to.
  * **Algorithm Name or ID**: Choose an algorithm name from the list or specify an ID using an [expression](/code/expressions.md).
  * **Encoding**: Select the encoding type to use. Choose from:
  	* **BASE64**
  	* **HEX**
  * **Private Key**: Enter a private key to use when signing the string.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Action","name":"action","type":"options","options":[{"name":"Generate","description":"Generate random string","value":"generate","action":"Generate random string"},{"name":"Hash","description":"Hash a text or file in a specified format","value":"hash","action":"Hash a text or file in a specified format"},{"name":"Hmac","description":"Hmac a text or file in a specified format","value":"hmac","action":"HMAC a text or file in a specified format"},{"name":"Sign","description":"Sign a string using a private key","value":"sign","action":"Sign a string using a private key"}],"default":"hash"},{"displayName":"Type","name":"type","displayOptions":{"show":{"action":["hash"]}},"type":"options","options":[{"name":"MD5","value":"MD5"},{"name":"SHA256","value":"SHA256"},{"name":"SHA3-256","value":"SHA3-256"},{"name":"SHA3-384","value":"SHA3-384"},{"name":"SHA3-512","value":"SHA3-512"},{"name":"SHA384","value":"SHA384"},{"name":"SHA512","value":"SHA512"}],"default":"MD5","description":"The hash type to use","required":true},{"displayName":"Binary Data","name":"binaryData","type":"boolean","default":false,"required":true,"displayOptions":{"show":{"action":["hash","hmac"]}},"description":"Whether the data to hashed should be taken from binary field"},{"displayName":"Binary Property Name","name":"binaryPropertyName","displayOptions":{"show":{"action":["hash","hmac"],"binaryData":[true]}},"type":"string","default":"data","description":"Name of the binary property which contains the input data","required":true},{"displayName":"Value","name":"value","displayOptions":{"show":{"action":["hash"],"binaryData":[false]}},"type":"string","default":"","description":"The value that should be hashed","required":true},{"displayName":"Property Name","name":"dataPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"action":["hash"]}},"description":"Name of the property to which to write the hash"},{"displayName":"Encoding","name":"encoding","displayOptions":{"show":{"action":["hash"]}},"type":"options","options":[{"name":"BASE64","value":"base64"},{"name":"HEX","value":"hex"}],"default":"hex","required":true},{"displayName":"Type","name":"type","displayOptions":{"show":{"action":["hmac"]}},"type":"options","options":[{"name":"MD5","value":"MD5"},{"name":"SHA256","value":"SHA256"},{"name":"SHA3-256","value":"SHA3-256"},{"name":"SHA3-384","value":"SHA3-384"},{"name":"SHA3-512","value":"SHA3-512"},{"name":"SHA384","value":"SHA384"},{"name":"SHA512","value":"SHA512"}],"default":"MD5","description":"The hash type to use","required":true},{"displayName":"Value","name":"value","displayOptions":{"show":{"action":["hmac"],"binaryData":[false]}},"type":"string","default":"","description":"The value of which the hmac should be created","required":true},{"displayName":"Property Name","name":"dataPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"action":["hmac"]}},"description":"Name of the property to which to write the hmac"},{"displayName":"Secret","name":"secret","displayOptions":{"show":{"action":["hmac"]}},"type":"string","typeOptions":{"password":true},"default":"","required":true},{"displayName":"Encoding","name":"encoding","displayOptions":{"show":{"action":["hmac"]}},"type":"options","options":[{"name":"BASE64","value":"base64"},{"name":"HEX","value":"hex"}],"default":"hex","required":true},{"displayName":"Value","name":"value","displayOptions":{"show":{"action":["sign"],"binaryData":[false]}},"type":"string","default":"","description":"The value that should be signed","required":true},{"displayName":"Property Name","name":"dataPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"action":["sign"]}},"description":"Name of the property to which to write the signed value"},{"displayName":"Algorithm Name or ID","name":"algorithm","displayOptions":{"show":{"action":["sign"]}},"type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","options":[{"name":"RSA-MD5","value":"RSA-MD5"},{"name":"RSA-RIPEMD160","value":"RSA-RIPEMD160"},{"name":"RSA-SHA1","value":"RSA-SHA1"},{"name":"RSA-SHA1-2","value":"RSA-SHA1-2"},{"name":"RSA-SHA224","value":"RSA-SHA224"},{"name":"RSA-SHA256","value":"RSA-SHA256"},{"name":"RSA-SHA3-224","value":"RSA-SHA3-224"},{"name":"RSA-SHA3-256","value":"RSA-SHA3-256"},{"name":"RSA-SHA3-384","value":"RSA-SHA3-384"},{"name":"RSA-SHA3-512","value":"RSA-SHA3-512"},{"name":"RSA-SHA384","value":"RSA-SHA384"},{"name":"RSA-SHA512","value":"RSA-SHA512"},{"name":"RSA-SHA512/224","value":"RSA-SHA512/224"},{"name":"RSA-SHA512/256","value":"RSA-SHA512/256"},{"name":"RSA-SM3","value":"RSA-SM3"},{"name":"blake2b512","value":"blake2b512"},{"name":"blake2s256","value":"blake2s256"},{"name":"id-rsassa-pkcs1-v1_5-with-sha3-224","value":"id-rsassa-pkcs1-v1_5-with-sha3-224"},{"name":"id-rsassa-pkcs1-v1_5-with-sha3-256","value":"id-rsassa-pkcs1-v1_5-with-sha3-256"},{"name":"id-rsassa-pkcs1-v1_5-with-sha3-384","value":"id-rsassa-pkcs1-v1_5-with-sha3-384"},{"name":"id-rsassa-pkcs1-v1_5-with-sha3-512","value":"id-rsassa-pkcs1-v1_5-with-sha3-512"},{"name":"md5","value":"md5"},{"name":"md5-sha1","value":"md5-sha1"},{"name":"md5WithRSAEncryption","value":"md5WithRSAEncryption"},{"name":"ripemd","value":"ripemd"},{"name":"ripemd160","value":"ripemd160"},{"name":"ripemd160WithRSA","value":"ripemd160WithRSA"},{"name":"rmd160","value":"rmd160"},{"name":"sha1","value":"sha1"},{"name":"sha1WithRSAEncryption","value":"sha1WithRSAEncryption"},{"name":"sha224","value":"sha224"},{"name":"sha224WithRSAEncryption","value":"sha224WithRSAEncryption"},{"name":"sha256","value":"sha256"},{"name":"sha256WithRSAEncryption","value":"sha256WithRSAEncryption"},{"name":"sha3-224","value":"sha3-224"},{"name":"sha3-256","value":"sha3-256"},{"name":"sha3-384","value":"sha3-384"},{"name":"sha3-512","value":"sha3-512"},{"name":"sha384","value":"sha384"},{"name":"sha384WithRSAEncryption","value":"sha384WithRSAEncryption"},{"name":"sha512","value":"sha512"},{"name":"sha512-224","value":"sha512-224"},{"name":"sha512-224WithRSAEncryption","value":"sha512-224WithRSAEncryption"},{"name":"sha512-256","value":"sha512-256"},{"name":"sha512-256WithRSAEncryption","value":"sha512-256WithRSAEncryption"},{"name":"sha512WithRSAEncryption","value":"sha512WithRSAEncryption"},{"name":"shake128","value":"shake128"},{"name":"shake256","value":"shake256"},{"name":"sm3","value":"sm3"},{"name":"sm3WithRSAEncryption","value":"sm3WithRSAEncryption"},{"name":"ssl3-md5","value":"ssl3-md5"},{"name":"ssl3-sha1","value":"ssl3-sha1"}],"default":"","required":true},{"displayName":"Encoding","name":"encoding","displayOptions":{"show":{"action":["sign"]}},"type":"options","options":[{"name":"BASE64","value":"base64"},{"name":"HEX","value":"hex"}],"default":"hex","required":true},{"displayName":"Private Key","name":"privateKey","displayOptions":{"show":{"action":["sign"]}},"type":"string","description":"Private key to use when signing the string","default":"","required":true},{"displayName":"Property Name","name":"dataPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"action":["generate"]}},"description":"Name of the property to which to write the random string"},{"displayName":"Type","name":"encodingType","displayOptions":{"show":{"action":["generate"]}},"type":"options","options":[{"name":"ASCII","value":"ascii"},{"name":"BASE64","value":"base64"},{"name":"HEX","value":"hex"},{"name":"UUID","value":"uuid"}],"default":"uuid","description":"Encoding that will be used to generate string","required":true},{"displayName":"Length","name":"stringLength","type":"number","default":32,"description":"Length of the generated string","displayOptions":{"show":{"action":["generate"],"encodingType":["ascii","base64","hex"]}}}]


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

  # Customer.io node

  Use the Customer.io node to automate work in Customer.io, and integrate Customer.io with other applications. n8n has built-in support for a wide range of Customer.io features, including creating and updating customers, tracking events, and getting campaigns.

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

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

  ## Operations

  * Customer
      * Create/Update a customer.
      * Delete a customer.
  * Event
      * Track a customer event.
      * Track an anonymous event.
  * Campaign
      * Get
      * Get All
      * Get Metrics
  * Segment
      * Add Customer
      * Remove Customer

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Customer","value":"customer"},{"name":"Event","value":"event"},{"name":"Campaign","value":"campaign"},{"name":"Segment","value":"segment"}],"default":"customer"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["campaign"]}},"options":[{"name":"Get","value":"get","action":"Get a campaign"},{"name":"Get Many","value":"getAll","action":"Get many campaigns"},{"name":"Get Metrics","value":"getMetrics","action":"Get metrics for a campaign"}],"default":"get"},{"displayName":"Campaign ID","name":"campaignId","type":"number","required":true,"default":0,"displayOptions":{"show":{"resource":["campaign"],"operation":["get"]}},"description":"The unique identifier for the campaign"},{"displayName":"Campaign ID","name":"campaignId","type":"number","required":true,"default":0,"displayOptions":{"show":{"resource":["campaign"],"operation":["getMetrics"]}},"description":"The unique identifier for the campaign"},{"displayName":"Period","name":"period","type":"options","default":"days","displayOptions":{"show":{"resource":["campaign"],"operation":["getMetrics"]}},"description":"Specify metric period","options":[{"name":"Hours","value":"hours"},{"name":"Days","value":"days"},{"name":"Weeks","value":"weeks"},{"name":"Months","value":"months"}]},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["campaign"],"operation":["getMetrics"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["campaign"],"operation":["getMetrics"],"jsonParameters":[false]}},"options":[{"displayName":"Steps","name":"steps","type":"number","default":0,"description":"Integer specifying how many steps to return. Defaults to the maximum number of timeperiods available, or 12 when using the months period. Maximum timeperiods available are 24 hours, 45 days, 12 weeks and 120 months","typeOptions":{"minValue":0,"maxValue":120}},{"displayName":"Type","name":"type","type":"options","default":"empty","description":"Specify metric type","options":[{"name":"Email","value":"email"},{"name":"Empty","value":"empty"},{"name":"Push","value":"push"},{"name":"Slack","value":"slack"},{"name":"Twilio","value":"twilio"},{"name":"Urban Airship","value":"urbanAirship"},{"name":"Webhook","value":"webhook"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["customer"]}},"options":[{"name":"Create or Update","value":"upsert","description":"Create a new customer, or update the current one if it already exists (upsert)","action":"Create or update a customer"},{"name":"Delete","value":"delete","description":"Delete a customer","action":"Delete a customer"}],"default":"upsert"},{"displayName":"ID","name":"id","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["customer"],"operation":["delete"]}},"description":"The unique identifier for the customer"},{"displayName":"ID","name":"id","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["customer"],"operation":["upsert"]}},"description":"The unique identifier for the customer"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["customer"],"operation":["upsert"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["customer"],"operation":["upsert"],"jsonParameters":[true]}},"description":"Object of values to set as described <a href=\"https://github.com/agilecrm/rest-api#1-companys---companies-api\">here</a>"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["customer"],"operation":["upsert"],"jsonParameters":[false]}},"options":[{"displayName":"Custom Properties","name":"customProperties","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"options":[{"displayName":"Property","name":"customProperty","values":[{"displayName":"Key","name":"key","type":"string","required":true,"default":"","description":"Property name","placeholder":"Plan"},{"displayName":"Value","name":"value","type":"string","required":true,"default":"","description":"Property value","placeholder":"Basic"}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The email address of the user"},{"displayName":"Created At","name":"createdAt","type":"dateTime","default":"","description":"The UNIX timestamp from when the user was created"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["event"]}},"options":[{"name":"Track","value":"track","description":"Track a customer event","action":"Track a customer event"},{"name":"Track Anonymous","value":"trackAnonymous","description":"Track an anonymous event","action":"Track an anonymous event"}],"default":"track"},{"displayName":"Customer ID","name":"customerId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["event"],"operation":["track"]}},"description":"The unique identifier for the customer"},{"displayName":"Event Name","name":"eventName","type":"string","default":"","displayOptions":{"show":{"resource":["event"],"operation":["track"]}},"description":"Name of the event to track"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["event"],"operation":["track"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["event"],"operation":["track"],"jsonParameters":[true]}},"description":"Object of values to set as described <a href=\"https://customer.io/docs/api-triggered-data-format#basic-data-formatting\">here</a>"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["track"],"jsonParameters":[false]}},"options":[{"displayName":"Custom Attributes","name":"customAttributes","type":"fixedCollection","default":{},"description":"Custom Properties","typeOptions":{"multipleValues":true},"options":[{"displayName":"Attribute","name":"customAttribute","values":[{"displayName":"Key","name":"key","type":"string","required":true,"default":"","description":"Attribute name","placeholder":"Price"},{"displayName":"Value","name":"value","type":"string","required":true,"default":"","description":"Attribute value","placeholder":"25.50"}]}]},{"displayName":"Type","name":"type","type":"string","default":"","description":"Used to change event type. For Page View events set to \"page\"."}]},{"displayName":"Event Name","name":"eventName","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["event"],"operation":["trackAnonymous"]}},"description":"The unique identifier for the customer"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["event"],"operation":["trackAnonymous"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["event"],"operation":["trackAnonymous"],"jsonParameters":[true]}},"description":"Object of values to set as described <a href=\"https://customer.io/docs/api-triggered-data-format#basic-data-formatting\">here</a>"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["trackAnonymous"],"jsonParameters":[false]}},"options":[{"displayName":"Custom Attributes","name":"customAttributes","type":"fixedCollection","default":{},"description":"Custom Properties","typeOptions":{"multipleValues":true},"options":[{"displayName":"Attribute","name":"customAttribute","values":[{"displayName":"Key","name":"key","type":"string","required":true,"default":"","description":"Attribute name","placeholder":"Price"},{"displayName":"Value","name":"value","type":"string","required":true,"default":"","description":"Attribute value","placeholder":"25.50"}]}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["segment"]}},"options":[{"name":"Add Customer","value":"add","action":"Add a customer to a segment"},{"name":"Remove Customer","value":"remove","action":"Remove a customer from a segment"}],"default":"add"},{"displayName":"Segment ID","name":"segmentId","type":"number","required":true,"default":0,"displayOptions":{"show":{"resource":["segment"],"operation":["add","remove"]}},"description":"The unique identifier of the segment"},{"displayName":"Customer IDs","name":"customerIds","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["segment"],"operation":["add","remove"]}},"description":"A list of customer IDs to add to the segment"}]

operations:
  [{"type":"resource","resource":"customer","name":"Customer"},{"type":"resource","resource":"event","name":"Event"},{"type":"resource","resource":"campaign","name":"Campaign"},{"type":"resource","resource":"segment","name":"Segment"},{"type":"operation","operation":"get","name":"Get","action":"Get a campaign","resources":["campaign"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many campaigns","resources":["campaign"]},{"type":"operation","operation":"getMetrics","name":"Get Metrics","action":"Get metrics for a campaign","resources":["campaign"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a customer","resources":["customer"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a customer","resources":["customer"]},{"type":"operation","operation":"track","name":"Track","action":"Track a customer event","resources":["event"]},{"type":"operation","operation":"trackAnonymous","name":"Track Anonymous","action":"Track an anonymous event","resources":["event"]},{"type":"operation","operation":"add","name":"Add Customer","action":"Add a customer to a segment","resources":["segment"]},{"type":"operation","operation":"remove","name":"Remove Customer","action":"Remove a customer from a segment","resources":["segment"]}]


node_type: customerIoTrigger
package_name: n8n-nodes-base
display_name: Customer.io Trigger
description: Starts the workflow on a Customer.io update (Beta)
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"customerIoApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Customer.io Trigger node documentation
  description: Learn how to use the Customer.io Trigger node in n8n. Follow technical documentation to integrate Customer.io Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Customer.io Trigger node

  [Customer.io](https://customer.io/){:target=_blank .external-link} enables users to send newsletters to selected segments of customers using their website data. You can send targeted emails, push notifications, and SMS to lower churn, create stronger relationships, and drive subscriptions.

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

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

properties_schema:
  [{"displayName":"Events","name":"events","type":"multiOptions","required":true,"default":[],"description":"The events that can trigger the webhook and whether they are enabled","options":[{"name":"Customer Subscribed","value":"customer.subscribed","description":"Whether the webhook is triggered when a list subscriber is added"},{"name":"Customer Unsubscribe","value":"customer.unsubscribed","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Attempted","value":"email.attempted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Bounced","value":"email.bounced","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Clicked","value":"email.clicked","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Converted","value":"email.converted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Delivered","value":"email.delivered","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Drafted","value":"email.drafted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Failed","value":"email.failed","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Opened","value":"email.opened","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Sent","value":"email.sent","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Email Spammed","value":"email.spammed","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Attempted","value":"push.attempted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Bounced","value":"push.bounced","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Clicked","value":"push.clicked","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Delivered","value":"push.delivered","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Drafted","value":"push.drafted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Failed","value":"push.failed","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Opened","value":"push.opened","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Push Sent","value":"push.sent","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Slack Attempted","value":"slack.attempted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Slack Clicked","value":"slack.clicked","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Slack Drafted","value":"slack.drafted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Slack Failed","value":"slack.failed","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"Slack Sent","value":"slack.sent","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Attempted","value":"sms.attempted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Bounced","value":"sms.bounced","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Clicked","value":"sms.clicked","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Delivered","value":"sms.delivered","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Drafted","value":"sms.drafted","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Failed","value":"sms.failed","description":"Whether the webhook is triggered when a list member unsubscribes"},{"name":"SMS Sent","value":"sms.sent","description":"Whether the webhook is triggered when a list member unsubscribes"}]}]


node_type: dateTime
package_name: n8n-nodes-base
display_name: Date & Time
description: Allows you to manipulate date and time values
category: transform
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: Date & Time
  description: Documentation for the Date & Time node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # Date & Time

  The Date & Time node manipulates date and time data and convert it to different formats.

  --8<-- "_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md"

  /// note | Date and time in other nodes
  You can work with data and time in the Code node, and in expressions in any node. n8n supports Luxon to help work with date and time in JavaScript. Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information.
  ///

  ## Operations

  * **Add to a Date**: Add a specified amount of time to a date.
  * **Extract Part of a Date**: Extract part of a date, such as the year, month, or day.
  * **Format a Date**: Transform a date's format to a new format using preset options or a custom expression.
  * **Get Current Date**: Get the current date and choose whether to include the current time or not. Useful for triggering other flows and conditional logic.
  * **Get Time Between Dates**: Calculate the amount of time in specific units between two dates.
  * **Round a Date**: Round a date up or down to the nearest unit of your choice, such as month, day, or hour.
  * **Subtract From a Date**: Subtract a specified amount of time from a date.

  Refer to the sections below for parameters and options specific to each operation.

  ## Add to a Date

  Configure the node for this operation using these parameters:

  * **Date to Add To**: Enter the date you want to change.
  * **Time Unit to Add**: Select the time unit for the **Duration** parameter.
  * **Duration**: Enter the number of time units to add to the date.
  * **Output Field Name**: Enter the name of the field to output the new date to.

  ### Add to a Date options

  This operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.

  ## Extract Part of a Date

  Configure the node for this operation using these parameters:

  * **Date**: Enter the date you want to round or extract part of.
  * **Part**: Select the part of the date you want to extract. Choose from:
      * **Year**
      * **Month**
      * **Week**
      * **Day**
      * **Hour**
      * **Minute**
      * **Second**
  * **Output Field Name**: Enter the name of the field to output the extracted date part to.

  ### Extract Part of a Date options

  This operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.

  ## Format a Date

  Configure the node for this operation using these parameters:

  * **Date**: Enter the date you want to format.
  * **Format**: Select the format you want to change the date to. Choose from:
      * **Custom Format**: Enter your own custom format using Luxon's [special tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens){:target=_blank .external-link}. Tokens are case-sensitive.
      * **MM/DD/YYYY**: For `4 September 1986`, this formats the date as `09/04/1986`.
      * **YYYY/MM/DD**: For `4 September 1986`, this formats the date as `1986/09/04`.
      * **MMMM DD YYYY**: For `4 September 1986`, this formats the date as `September 04 1986`.
      * **MM-DD-YYYY**: For `4 September 1986`, this formats the date as `09-04-1986`.
      * **YYYY-MM-DD**: For `4 September 1986`, this formats the date as `1986-09-04`.
  * **Output Field Name**: Enter the name of the field to output the formatted date to.

  ### Format a Date options

  This operation includes these options:

  * **Include Input Fields**: If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.
  * **From Date Format**: If the node isn't recognizing the **Date** format correctly, enter the format for that **Date** here so the node can process it properly. Use Luxon's [special tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens){:target=_blank .external-link} to enter the format. Tokens are case-sensitive
  * **Use Workflow Timezone**: Whether to use the input's time zone (turned off) or the workflow's timezone (turned on).

  ## Get Current Date

  Configure the node for this operation using these parameters:

  * **Include Current Time**: Choose whether to include the current time (turned on) or to set the time to midnight (turned off).
  * **Output Field Name**: Enter the name of the field to output the current date to.

  ### Get Current Date options

  This operation includes these options:

  * **Include Input Fields**: If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.
  * **Timezone**: Set the timezone to use. If left blank, the node uses the n8n instance's timezone.

  /// note | +00:00 timezone
  Use `GMT` for +00:00 timezone.
  ///

  ## Get Time Between Dates

  Configure the node for this operation using these parameters:

  * **Start Date**: Enter the earlier date you want to compare.
  * **End Date**: Enter the later date you want to compare.
  * **Units**: Select the units you want to calculate the time between. You can include multiple units. Choose from:
      * **Year**
      * **Month**
      * **Week**
      * **Day**
      * **Hour**
      * **Minute**
      * **Second**
      * **Millisecond**
  * **Output Field Name**: Enter the name of the field to output the calculated time between to.

  ### Get Time Between Dates options

  The Get Time Between Dates operation includes the **Include Input Fields** option as well as an **Output as ISO String** option. If you leave this option off, each unit you selected will return its own time difference calculation, for example:

      timeDifference
      years : 1
      months : 3
      days : 13

  If you turn on the **Output as ISO String** option, the node formats the output as a single ISO duration string, for example: `P1Y3M13D`.

  ISO duration format displays a format as `P<n>Y<n>M<n>DT<n>H<n>M<n>S`. `<n>` is the number for the unit after it.

  * P = period (duration). It begins all ISO duration strings.
  * Y = years
  * M = months
  * W = weeks
  * D = days
  * T = delineator between dates and times, used to avoid confusion between months and minutes
  * H = hours
  * M = minutes
  * S = seconds

  Milliseconds don't get their own unit, but instead are decimal seconds. For example, 2.1 milliseconds is `0.0021S`.

  ## Round a Date

  Configure the node for this operation using these parameters:

  * **Date**: Enter the date you'd like to round.
  * **Mode**: Choose whether to **Round Down** or **Round Up**.
  * **To Nearest**: Select the unit you'd like to round to. Choose from:
      * **Year**
      * **Month**
      * **Week**
      * **Day**
      * **Hour**
      * **Minute**
      * **Second**
  * **Output Field Name**: Enter the name of the field to output the rounded date to.

  ### Round a Date options

  This operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.

  ## Subtract From a Date

  Configure the node for this operation using these parameters:

  * **Date to Subtract From**: Enter the date you'd like to subtract from.
  * **Time Unit to Subtract**: Select the unit for the **Duration** amount you want to subtract.
  * **Duration**: Enter the amount of the time units you want to subtract from the **Date to Subtract From**.
  * **Output Field Name**: Enter the name of the field to output the rounded date to.

  ### Subtract From a Date options

  This operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.

  ## Templates and examples

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

  ## Related resources

  The Date & Time node uses [Luxon](https://moment.github.io/luxon){:target=_blank .external-link}. You can also use Luxon in the [Code](/code/code-node.md) node and [expressions](/code/expressions.md). Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information.

  ### Supported date formats

  n8n supports all date formats [supported by Luxon](https://moment.github.io/luxon/#/formatting?id=table-of-tokens){:target=_blank .external-link}. Tokens are case-sensitive.


node_type: debugHelper
package_name: n8n-nodes-base
display_name: DebugHelper
description: Causes problems intentionally and generates useful data for debugging
category: output
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: Debug Helper
  description: Documentation for the Debug Helper node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Debug Helper

  Use the Debug Helper node to trigger different error types or generate random datasets to help test n8n workflows.

  ## Operations

  Define the operation by selecting the **Category**:

  * **Do Nothing**: Don't do anything.
  * [**Throw Error**](#throw-error): Throw an error with the specified type and message.
  * [**Out Of Memory**](#out-of-memory): Generate a specific memory size to simulate being out of memory.
  * [**Generate Random Data**](#generate-random-data): Generate some random data in a selected format.

  ## Node parameters

  The node parameters depend on the **Category** selected. The **Do Nothing** Category has no other parameters.

  ### Throw Error

  * **Error Type**: Select the type of error to throw. Choose from:
  	* **NodeApiError**
  	* **NodeOperationError**
  	* **Error**
  * **Error Message**: Enter the error message to throw.

  ### Out Of Memory

  The Out of Memory Category adds one parameter, the **Memory Size to Generate**. Enter the approximate amount of memory to generate.

  ### Generate Random Data

  * **Data Type**: Choose the type of random data you'd like to generate. Options include:
  	* **Address**
  	* **Coordinates**
  	* **Credit Card**
  	* **Email**
  	* **IPv4**
  	* **IPv6**
  	* **MAC**
  	* **Nanoids**: If you select this data type, you'll also need to enter:
  		* **Nanoid Alphabet**: The alphabet the generator will use to generate the nanoids.
  		* **Nanoid Length**: The length of each nanoid.
  	* **URL**
  	* **User Data**
  	* **UUID**
  	* **Version**
  * **Seed**: If you'd like to generate the data using a specific seed, enter it here. This ensures the data gets generated consistently. If you'd rather use random data generation, leave this field empty.
  * **Number of Items to Generate**: Enter the number of random items you'd like to generate.
  * **Output as Single Array**: Whether to generate the data as a single array (turned on) or multiple items (turned off).

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Category","name":"category","type":"options","noDataExpression":true,"options":[{"name":"Do Nothing","value":"doNothing","description":"Does nothing"},{"name":"Throw Error","value":"throwError","description":"Throws an error with the specified type and message"},{"name":"Out Of Memory","value":"oom","description":"Generates a large amount of memory to cause an out of memory error"},{"name":"Generate Random Data","value":"randomData","description":"Generates random data sets"}],"default":"throwError"},{"displayName":"Error Type","name":"throwErrorType","type":"options","noDataExpression":true,"options":[{"name":"NodeApiError","value":"NodeApiError"},{"name":"NodeOperationError","value":"NodeOperationError"},{"name":"Error","value":"Error"}],"default":"NodeApiError","displayOptions":{"show":{"category":["throwError"]}}},{"displayName":"Error Message","name":"throwErrorMessage","type":"string","default":"Node has thrown an error","description":"The message to send as part of the error","displayOptions":{"show":{"category":["throwError"]}}},{"displayName":"Memory Size to Generate","name":"memorySizeValue","type":"number","default":10,"description":"The approximate amount of memory to generate. Be generous...","displayOptions":{"show":{"category":["oom"]}}},{"displayName":"Data Type","name":"randomDataType","type":"options","noDataExpression":true,"options":[{"name":"Address","value":"address"},{"name":"Coordinates","value":"latLong"},{"name":"Credit Card","value":"creditCard"},{"name":"Email","value":"email"},{"name":"IPv4","value":"ipv4"},{"name":"IPv6","value":"ipv6"},{"name":"MAC","value":"macAddress"},{"name":"NanoIds","value":"nanoid"},{"name":"URL","value":"url"},{"name":"User Data","value":"user"},{"name":"UUID","value":"uuid"},{"name":"Version","value":"semver"}],"default":"user","displayOptions":{"show":{"category":["randomData"]}}},{"displayName":"NanoId Alphabet","name":"nanoidAlphabet","type":"string","default":"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ","description":"The alphabet to use for generating the nanoIds","displayOptions":{"show":{"category":["randomData"],"randomDataType":["nanoid"]}}},{"displayName":"NanoId Length","name":"nanoidLength","type":"string","default":"16","description":"The length of each nanoIds","displayOptions":{"show":{"category":["randomData"],"randomDataType":["nanoid"]}}},{"displayName":"Seed","name":"randomDataSeed","type":"string","default":"","placeholder":"Leave empty for random seed","description":"If set, seed to use for generating the data (same seed will generate the same data)","displayOptions":{"show":{"category":["randomData"]}}},{"displayName":"Number of Items to Generate","name":"randomDataCount","type":"number","default":10,"description":"The number of random data items to generate into an array","displayOptions":{"show":{"category":["randomData"]}}},{"displayName":"Output as Single Array","name":"randomDataSingleArray","type":"boolean","default":false,"description":"Whether to output a single array instead of multiple items","displayOptions":{"show":{"category":["randomData"]}}}]


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

  # DeepL node

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

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

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

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

  ## Operations

  * Language
      * Translate data

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Language","value":"language"}],"default":"language"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["language"]}},"options":[{"name":"Translate","value":"translate","description":"Translate data","action":"Translate a language"}],"default":"translate"},{"displayName":"Text","name":"text","type":"string","default":"","description":"Input text to translate","required":true,"displayOptions":{"show":{"operation":["translate"]}}},{"displayName":"Target Language Name or ID","name":"translateTo","type":"options","typeOptions":{"loadOptionsMethod":"getLanguages"},"default":"","description":"Language to translate to. 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":{"operation":["translate"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Source Language Name or ID","name":"sourceLang","type":"options","default":"","description":"Language to translate from. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","typeOptions":{"loadOptionsMethod":"getLanguages"}},{"displayName":"Split Sentences","name":"splitSentences","type":"options","default":"1","description":"How the translation engine should split sentences","options":[{"name":"Interpunction Only","value":"nonewlines","description":"Split text on interpunction only, ignoring newlines"},{"name":"No Splitting","value":"0","description":"Treat all text as a single sentence"},{"name":"On Punctuation and Newlines","value":"1","description":"Split text on interpunction and newlines"}]},{"displayName":"Preserve Formatting","name":"preserveFormatting","type":"options","default":"0","description":"Whether the translation engine should respect the original formatting, even if it would usually correct some aspects","options":[{"name":"Apply Corrections","value":"0","description":"Fix punctuation at the beginning and end of sentences and fixes lower/upper caseing at the beginning"},{"name":"Do Not Correct","value":"1","description":"Keep text as similar as possible to the original"}]},{"displayName":"Formality","name":"formality","type":"options","default":"default","description":"How formal or informal the target text should be. May not be supported with all languages.","options":[{"name":"Formal","value":"more"},{"name":"Informal","value":"less"},{"name":"Neutral","value":"default"}]}]}]

operations:
  [{"type":"resource","resource":"language","name":"Language"},{"type":"operation","operation":"translate","name":"Translate","action":"Translate a language","resources":["language"]}]


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

  # Demio node

  Use the Demio node to automate work in Demio, and integrate Demio with other applications. n8n has built-in support for a wide range of Demio features, including getting, and registering events and reports.

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

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

  ## Operations

  * Event
      * Get an event
      * Get all events
      * Register someone to an event
  * Report
      * Get an event report

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Event","value":"event"},{"name":"Report","value":"report"}],"default":"event"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["event"]}},"options":[{"name":"Get","value":"get","description":"Get an event","action":"Get an event"},{"name":"Get Many","value":"getAll","description":"Get many events","action":"Get many events"},{"name":"Register","value":"register","description":"Register someone to an event","action":"Register an event"}],"default":"get"},{"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":500},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["getAll"]}},"options":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"Automated","value":"automated"},{"name":"Past","value":"past"},{"name":"Upcoming","value":"upcoming"}],"default":""}]},{"displayName":"Event ID","name":"eventId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["event"],"operation":["get"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["get"]}},"options":[{"displayName":"Active","name":"active","type":"boolean","default":false,"description":"Whether to return only active dates in series"},{"displayName":"Session ID","name":"date_id","type":"string","default":"","description":"Event Date ID"}]},{"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"},"displayOptions":{"show":{"resource":["event"],"operation":["register"]}},"default":""},{"displayName":"First Name","name":"firstName","type":"string","default":"","required":true,"description":"The registrant's first name","displayOptions":{"show":{"resource":["event"],"operation":["register"]}}},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","required":true,"description":"The registrant's email address","displayOptions":{"show":{"resource":["event"],"operation":["register"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["event"],"operation":["register"]}},"options":[{"displayName":"Company","name":"company","type":"string","default":"","description":"The value for the predefined Company field"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field ID","name":"fieldId","type":"string","default":"","description":"Each custom field's unique identifier can be found within the Event's Registration block in the Customize tab"},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Event Registration URL","name":"ref_url","type":"string","default":"","description":"Event Registration page URL. It can be useful when you do not know Event ID, but have Event link."},{"displayName":"GDPR","name":"gdpr","type":"string","default":"","description":"The value for the predefined GDPR field"},{"displayName":"Last Name","name":"last_name","type":"string","default":"","description":"The value for the predefined Last Name field"},{"displayName":"Phone Number","name":"phone_number","type":"string","default":"","description":"The value for the predefined Phone Number field"},{"displayName":"Session Name or ID","name":"date_id","type":"options","typeOptions":{"loadOptionsMethod":"getEventSessions","loadOptionsDependsOn":["eventId"]},"default":"","description":"Event Session ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Website","name":"website","type":"string","default":"","description":"The value for the predefined Website field"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["report"]}},"options":[{"name":"Get","value":"get","description":"Get an event report","action":"Get a report"}],"default":"get"},{"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"},"displayOptions":{"show":{"resource":["report"],"operation":["get"]}},"default":""},{"displayName":"Session Name or ID","name":"dateId","type":"options","typeOptions":{"loadOptionsMethod":"getEventSessions","loadOptionsDependsOn":["eventId"]},"default":"","required":true,"description":"ID of the session. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["report"],"operation":["get"]}}},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["report"],"operation":["get"]}},"options":[{"displayName":"Status","name":"status","type":"options","options":[{"name":"Attended","value":"attended"},{"name":"Banned","value":"banned"},{"name":"Completed","value":"completed"},{"name":"Did Not Attend","value":"did-not-attend"},{"name":"Left Early","value":"left-early"}],"default":"","description":"Filter results by participation status"}]}]

operations:
  [{"type":"resource","resource":"event","name":"Event"},{"type":"resource","resource":"report","name":"Report"},{"type":"operation","operation":"get","name":"Get","action":"Get an event","resources":["event"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many events","resources":["event"]},{"type":"operation","operation":"register","name":"Register","action":"Register an event","resources":["event"]},{"type":"operation","operation":"get","name":"Get","action":"Get a report","resources":["report"]}]


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

  # DHL node

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

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

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

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

  ## Operations

  * Shipment
      * Get Tracking Details

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","noDataExpression":true,"type":"hidden","options":[{"name":"Shipment","value":"shipment"}],"default":"shipment"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["shipment"]}},"options":[{"name":"Get Tracking Details","value":"get","action":"Get tracking details for a shipment"}],"default":"get"},{"displayName":"Tracking Number","name":"trackingNumber","type":"string","required":true,"default":""},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Recipient's Postal Code","name":"recipientPostalCode","type":"string","default":"","description":"DHL will return more detailed information on the shipment when you provide the Recipient's Postal Code - it acts as a verification step"}]}]

operations:
  [{"type":"operation","operation":"get","name":"Get Tracking Details","action":"Get tracking details for a shipment","resources":["shipment"]}]


node_type: discord
package_name: n8n-nodes-base
display_name: Discord
description: Sends data to Discord
category: output
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: Discord node documentation
  description: Learn how to use the Discord node in n8n. Follow technical documentation to integrate Discord node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Discord node

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

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

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

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

  ## Operations
  <!-- vale off -->
  <!-- "Many" triggers warnings -->

  - Channel
  	- Create
  	- Delete
  	- Get
  	- Get Many
  	- Update
  - Message
  	- Delete
  	- Get
  	- Get Many
  	- React with Emoji
  	- Send
  	* Send and Wait for Response
  - Member
  	- Get Many
  	- Role Add
  	- Role Remove

  --8<-- "_snippets/integrations/builtin/send-and-wait-operation.md"

  <!-- vale on -->

  ## Templates and examples

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

  ## Related resources

  Refer to [Discord's documentation](https://discord.com/developers/docs/intro){:target=_blank .external-link} for more information about the service.

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

  ## Common issues

  For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.discord/common-issues.md).

properties_schema:
  [{"displayName":"Webhook URL","name":"webhookUri","type":"string","required":true,"default":"","placeholder":"https://discord.com/api/webhooks/ID/TOKEN"},{"displayName":"Content","name":"text","type":"string","typeOptions":{"maxValue":2000},"default":"","placeholder":"Hello World!"},{"displayName":"Additional Fields","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Allowed Mentions","name":"allowedMentions","type":"json","typeOptions":{"alwaysOpenEditWindow":true,"editor":"code"},"default":""},{"displayName":"Attachments","name":"attachments","type":"json","typeOptions":{"alwaysOpenEditWindow":true,"editor":"code"},"default":""},{"displayName":"Avatar URL","name":"avatarUrl","type":"string","default":""},{"displayName":"Components","name":"components","type":"json","typeOptions":{"alwaysOpenEditWindow":true,"editor":"code"},"default":""},{"displayName":"Embeds","name":"embeds","type":"json","typeOptions":{"alwaysOpenEditWindow":true,"editor":"code"},"default":""},{"displayName":"Flags","name":"flags","type":"number","default":""},{"displayName":"JSON Payload","name":"payloadJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true,"editor":"code"},"default":""},{"displayName":"Username","name":"username","type":"string","default":"","placeholder":"User"},{"displayName":"TTS","name":"tts","type":"boolean","default":false,"description":"Whether this message be sent as a Text To Speech message"}]}]


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

  # Discourse node

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

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

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

  ## Operations

  * Category
      * Create a category
      * Get all categories
      * Update a category
  * Group
      * Create a group
      * Get a group
      * Get all groups
      * Update a group
  * Post
      * Create a post
      * Get a post
      * Get all posts
      * Update a post
  * User
      * Create a user
      * Get a user
      * Get all users
  * User Group
      * Create a user to group
      * Remove user from group

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Category","value":"category"},{"name":"Group","value":"group"},{"name":"Post","value":"post"},{"name":"User","value":"user"},{"name":"User Group","value":"userGroup"}],"default":"post"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"description":"Choose an operation","required":true,"displayOptions":{"show":{"resource":["category"]}},"options":[{"name":"Create","value":"create","description":"Create a category","action":"Create a category"},{"name":"Get Many","value":"getAll","description":"Get many categories","action":"Get many categories"},{"name":"Update","value":"update","description":"Update a category","action":"Update a category"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["category"],"operation":["create"]}},"default":"","description":"Name of the category"},{"displayName":"Color","name":"color","type":"color","required":true,"displayOptions":{"show":{"resource":["category"],"operation":["create"]}},"default":"0000FF","description":"Color of the category"},{"displayName":"Text Color","name":"textColor","type":"color","required":true,"displayOptions":{"show":{"resource":["category"],"operation":["create"]}},"default":"0000FF","description":"Text color of the category"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["category"],"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":["category"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Category ID","name":"categoryId","type":"string","required":true,"displayOptions":{"show":{"resource":["category"],"operation":["update"]}},"default":"","description":"ID of the category"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["category"],"operation":["update"]}},"default":"","description":"New name of the category"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["category"],"operation":["update"]}},"options":[{"displayName":"Color","name":"color","type":"color","default":"0000FF","description":"Color of the category"},{"displayName":"Text Color","name":"textColor","type":"color","default":"0000FF","description":"Text color of the category"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"description":"Choose an operation","required":true,"displayOptions":{"show":{"resource":["group"]}},"options":[{"name":"Create","value":"create","description":"Create a group","action":"Create a group"},{"name":"Get","value":"get","description":"Get a group","action":"Get a group"},{"name":"Get Many","value":"getAll","description":"Get many groups","action":"Get many groups"},{"name":"Update","value":"update","description":"Update a group","action":"Update a group"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["group"],"operation":["get","create"]}},"default":"","description":"Name of the group"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["group"],"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":["group"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Group ID","name":"groupId","type":"string","required":true,"displayOptions":{"show":{"resource":["group"],"operation":["update"]}},"default":"","description":"ID of the group to update"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["group"],"operation":["update"]}},"default":"","description":"New name of the group"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"description":"Choose an operation","required":true,"displayOptions":{"show":{"resource":["post"]}},"options":[{"name":"Create","value":"create","description":"Create a post","action":"Create a post"},{"name":"Get","value":"get","description":"Get a post","action":"Get a post"},{"name":"Get Many","value":"getAll","description":"Get many posts","action":"Get many posts"},{"name":"Update","value":"update","description":"Update a post","action":"Update a post"}],"default":"create"},{"displayName":"Title","name":"title","type":"string","displayOptions":{"show":{"resource":["post"],"operation":["create"]}},"default":"","description":"Title of the post"},{"displayName":"Content","name":"content","type":"string","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["create"]}},"default":"","description":"Content of the post"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["post"]}},"default":{},"options":[{"displayName":"Category Name or ID","name":"category","type":"options","typeOptions":{"loadOptionsMethod":"getCategories"},"default":"","description":"ID of the category. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Reply To Post Number","name":"reply_to_post_number","type":"string","default":"","description":"The number of the post to reply to"},{"displayName":"Topic ID","name":"topic_id","type":"string","default":"","description":"ID of the topic"}]},{"displayName":"Post ID","name":"postId","type":"string","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["get"]}},"default":"","description":"ID of the post"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["post"],"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":["post"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Post ID","name":"postId","type":"string","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["update"]}},"default":"","description":"ID of the post"},{"displayName":"Content","name":"content","type":"string","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["update"]}},"default":"","description":"Content of the post. HTML is supported."},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["post"],"operation":["update"]}},"options":[{"displayName":"Edit Reason","name":"edit_reason","type":"string","default":""},{"displayName":"Cooked","name":"cooked","type":"boolean","default":false}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"description":"Choose an operation","required":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Create","value":"create","description":"Create a user","action":"Create a user"},{"name":"Get","value":"get","description":"Get a user","action":"Get a user"},{"name":"Get Many","value":"getAll","description":"Get many users","action":"Get many users"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"default":"","description":"Name of the user to create"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"default":"","description":"Email of the user to create"},{"displayName":"Username","name":"username","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"default":"","description":"The username of the user to create"},{"displayName":"Password","name":"password","type":"string","typeOptions":{"password":true},"required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"default":"","description":"The password of the user to create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"options":[{"displayName":"Active","name":"active","type":"boolean","default":false},{"displayName":"Approved","name":"approved","type":"boolean","default":false}]},{"displayName":"By","name":"by","type":"options","options":[{"name":"Username","value":"username"},{"name":"SSO External ID","value":"externalId"}],"required":true,"displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"default":"username","description":"What to search by"},{"displayName":"Username","name":"username","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["get"],"by":["username"]}},"default":"","description":"The username of the user to return"},{"displayName":"SSO External ID","name":"externalId","type":"string","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["get"],"by":["externalId"]}},"default":"","description":"Discourse SSO external ID"},{"displayName":"Flag","name":"flag","type":"options","options":[{"name":"Active","value":"active"},{"name":"Blocked","value":"blocked"},{"name":"New","value":"new"},{"name":"Staff","value":"staff"},{"name":"Suspect","value":"suspect"}],"displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"default":"","description":"User flags to search for"},{"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":100},"default":50,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"description":"Choose an operation","required":true,"displayOptions":{"show":{"resource":["userGroup"]}},"options":[{"name":"Add","value":"add","description":"Create a user to group","action":"Add a user to a group"},{"name":"Remove","value":"remove","description":"Remove user from group","action":"Remove a user from a group"}],"default":"add"},{"displayName":"Usernames","name":"usernames","type":"string","required":true,"displayOptions":{"show":{"resource":["userGroup"],"operation":["add"]}},"default":"","description":"Usernames to add to group. Multiples can be defined separated by comma."},{"displayName":"Group ID","name":"groupId","type":"string","required":true,"displayOptions":{"show":{"resource":["userGroup"],"operation":["add"]}},"default":"","description":"ID of the group"},{"displayName":"Usernames","name":"usernames","type":"string","required":true,"displayOptions":{"show":{"resource":["userGroup"],"operation":["remove"]}},"default":"","description":"Usernames to remove from group. Multiples can be defined separated by comma."},{"displayName":"Group ID","name":"groupId","type":"string","required":true,"displayOptions":{"show":{"resource":["userGroup"],"operation":["remove"]}},"default":"","description":"ID of the group to remove"}]

operations:
  [{"type":"resource","resource":"category","name":"Category"},{"type":"resource","resource":"group","name":"Group"},{"type":"resource","resource":"post","name":"Post"},{"type":"resource","resource":"user","name":"User"},{"type":"resource","resource":"userGroup","name":"User Group"},{"type":"operation","operation":"create","name":"Create","action":"Create a category","resources":["category"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many categories","resources":["category"]},{"type":"operation","operation":"update","name":"Update","action":"Update a category","resources":["category"]},{"type":"operation","operation":"create","name":"Create","action":"Create a group","resources":["group"]},{"type":"operation","operation":"get","name":"Get","action":"Get a group","resources":["group"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many groups","resources":["group"]},{"type":"operation","operation":"update","name":"Update","action":"Update a group","resources":["group"]},{"type":"operation","operation":"create","name":"Create","action":"Create a post","resources":["post"]},{"type":"operation","operation":"get","name":"Get","action":"Get a post","resources":["post"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many posts","resources":["post"]},{"type":"operation","operation":"update","name":"Update","action":"Update a post","resources":["post"]},{"type":"operation","operation":"create","name":"Create","action":"Create 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":"add","name":"Add","action":"Add a user to a group","resources":["userGroup"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a user from a group","resources":["userGroup"]}]


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

  # Disqus node

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

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

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

  ## Operations

  * Forum
      * Return forum details
      * Return a list of categories within a forum
      * Return a list of threads within a forum
      * Return a list of posts within a forum

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Forum","value":"forum"}],"default":"forum"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["forum"]}},"options":[{"name":"Get","value":"get","description":"Return forum details","action":"Get a forum"},{"name":"Get All Categories","value":"getCategories","description":"Return a list of categories within a forum","action":"Get all categories in a forum"},{"name":"Get All Threads","value":"getThreads","description":"Return a list of threads within a forum","action":"Get all threads in a forum"},{"name":"Get All Posts","value":"getPosts","description":"Return a list of posts within a forum","action":"Get all posts in a forum"}],"default":"get"},{"displayName":"Forum Name","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["forum"]}},"description":"The short name(aka ID) of the forum to get"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["get"],"resource":["forum"]}},"default":{},"options":[{"displayName":"Attach","name":"attach","type":"multiOptions","options":[{"name":"Counters","value":"counters"},{"name":"followsForum","value":"followsForum"},{"name":"forumCanDisableAds","value":"forumCanDisableAds"},{"name":"forumDaysAlive","value":"forumDaysAlive"},{"name":"forumFeatures","value":"forumFeatures"},{"name":"forumForumCategory","value":"forumForumCategory"},{"name":"forumIntegration","value":"forumIntegration"},{"name":"forumNewPolicy","value":"forumNewPolicy"},{"name":"forumPermissions","value":"forumPermissions"}],"default":[]},{"displayName":"Related","name":"related","type":"multiOptions","options":[{"name":"author","value":"author"}],"default":[],"description":"You may specify relations to include with your response"}]},{"displayName":"Forum Name","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["getPosts"],"resource":["forum"]}},"description":"The short name(aka ID) of the forum to get"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["forum"],"operation":["getPosts"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["forum"],"operation":["getPosts"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getPosts"],"resource":["forum"]}},"default":{},"options":[{"displayName":"Filters","name":"filters","type":"multiOptions","options":[{"name":"Has_Bad_Word","value":"Has_Bad_Word"},{"name":"Has_Link","value":"Has_Link"},{"name":"Has_Low_Rep_Author","value":"Has_Low_Rep_Author"},{"name":"Has_Media","value":"Has_Media"},{"name":"Is_Anonymous","value":"Is_Anonymous"},{"name":"Is_At_Flag_Limit","value":"Is_At_Flag_Limit"},{"name":"Is_Flagged","value":"Is_Flagged"},{"name":"Is_Toxic","value":"Is_Toxic"},{"name":"Modified_By_Rule","value":"Modified_By_Rule"},{"name":"No_Issue","value":"No_Issue"},{"name":"Shadow_Banned","value":"Shadow_Banned"}],"default":[],"description":"You may specify filters for your response"},{"displayName":"Include","name":"include","type":"multiOptions","options":[{"name":"Approved","value":"approved"}],"default":[],"description":"You may specify relations to include with your response"},{"displayName":"Order","name":"order","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"asc","description":"You may specify order to sort your response"},{"displayName":"Query","name":"query","type":"string","default":"","description":"You may specify query forChoices: asc, desc your response"},{"displayName":"Related","name":"related","type":"multiOptions","options":[{"name":"Thread","value":"thread"}],"default":[],"description":"You may specify relations to include with your response"},{"displayName":"Since","name":"since","type":"dateTime","default":"","description":"Unix timestamp (or ISO datetime standard)"}]},{"displayName":"Forum Name","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["getCategories"],"resource":["forum"]}},"description":"The short name(aka ID) of the forum to get Categories"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["forum"],"operation":["getCategories"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["forum"],"operation":["getCategories"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getCategories"],"resource":["forum"]}},"default":{},"options":[{"displayName":"Order","name":"order","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"asc","description":"You may specify order to sort your response"}]},{"displayName":"Forum Name","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["getThreads"],"resource":["forum"]}},"description":"The short name(aka ID) of the forum to get Threads"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["forum"],"operation":["getThreads"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["forum"],"operation":["getThreads"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getThreads"],"resource":["forum"]}},"default":{},"options":[{"displayName":"Related","name":"related","type":"multiOptions","options":[{"name":"author","value":"author"},{"name":"Forum","value":"forum"}],"default":[],"description":"You may specify relations to include with your response"},{"displayName":"Include","name":"include","type":"multiOptions","options":[{"name":"Closed","value":"closed"},{"name":"Open","value":"open"},{"name":"Killed","value":"killed"}],"default":[],"description":"You may specify relations to include with your response"},{"displayName":"Order","name":"order","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"asc","description":"You may specify order to sort your response"},{"displayName":"Since","name":"since","type":"dateTime","default":"","description":"Unix timestamp (or ISO datetime standard)"},{"displayName":"Thread","name":"thread","type":"string","default":"","description":"Looks up a thread by ID. You may pass us the \"ident\" query type instead of an ID by including \"forum\". You may pass us the \"link\" query type to filter by URL. You must pass the \"forum\" if you do not have the Pro API Access addon."}]}]

operations:
  [{"type":"resource","resource":"forum","name":"Forum"},{"type":"operation","operation":"get","name":"Get","action":"Get a forum","resources":["forum"]},{"type":"operation","operation":"getCategories","name":"Get All Categories","action":"Get all categories in a forum","resources":["forum"]},{"type":"operation","operation":"getThreads","name":"Get All Threads","action":"Get all threads in a forum","resources":["forum"]},{"type":"operation","operation":"getPosts","name":"Get All Posts","action":"Get all posts in a forum","resources":["forum"]}]


node_type: drift
package_name: n8n-nodes-base
display_name: Drift
description: Consume Drift 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: Drift node documentation
  description: Learn how to use the Drift node in n8n. Follow technical documentation to integrate Drift node into your workflows.
  contentType: [integration, reference]
  ---

  # Drift node

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

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

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

  ## Operations

  * Contact
      * Create a contact
      * Get custom attributes
      * Delete a contact
      * Get a contact
      * Update a contact

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"Access Token","value":"accessToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"accessToken"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Contact","value":"contact"}],"default":"contact"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"options":[{"name":"Create","value":"create","description":"Create a contact","action":"Create a contact"},{"name":"Custom Attributes","value":"getCustomAttributes","description":"Get custom attributes","action":"Get custom attributes for a contact"},{"name":"Delete","value":"delete","description":"Delete a contact","action":"Delete a contact"},{"name":"Get","value":"get","description":"Get a contact","action":"Get a contact"},{"name":"Update","value":"update","description":"Update a contact","action":"Update a contact"}],"default":"create"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"description":"The email of the contact"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"The name of the contact"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The phone number associated with the contact"}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"description":"Unique identifier for the contact"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"options":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The email of the contact"},{"displayName":"Name","name":"name","type":"string","default":"","description":"The name of the contact"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The phone number associated with the contact"}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["get"]}},"description":"Unique identifier for the contact"},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["delete"]}},"description":"Unique identifier for the contact"}]

operations:
  [{"type":"resource","resource":"contact","name":"Contact"},{"type":"operation","operation":"create","name":"Create","action":"Create a contact","resources":["contact"]},{"type":"operation","operation":"getCustomAttributes","name":"Custom Attributes","action":"Get custom attributes for 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":"update","name":"Update","action":"Update a contact","resources":["contact"]}]

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


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

  # Dropbox node

  Use the Dropbox node to automate work in Dropbox, and integrate Dropbox with other applications. n8n has built-in support for a wide range of Dropbox features, including creating, downloading, moving, and copying files and folders.

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

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

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

  ## Operations

  * File
      * Copy a file
      * Delete a file
      * Download a file
      * Move a file
      * Upload a file
  * Folder
      * Copy a folder
      * Create a folder
      * Delete a folder
      * Return the files and folders in a given folder
      * Move a folder
  * Search
      * Query

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"Access Token","value":"accessToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"accessToken","description":"Means of authenticating with the service"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"File","value":"file"},{"name":"Folder","value":"folder"},{"name":"Search","value":"search"}],"default":"file"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["file"]}},"options":[{"name":"Copy","value":"copy","description":"Copy a file","action":"Copy a file"},{"name":"Delete","value":"delete","description":"Delete a file","action":"Delete a file"},{"name":"Download","value":"download","description":"Download a file","action":"Download a file"},{"name":"Move","value":"move","description":"Move a file","action":"Move a file"},{"name":"Upload","value":"upload","description":"Upload a file","action":"Upload a file"}],"default":"upload"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["folder"]}},"options":[{"name":"Copy","value":"copy","description":"Copy a folder","action":"Copy a folder"},{"name":"Create","value":"create","description":"Create a folder","action":"Create a folder"},{"name":"Delete","value":"delete","description":"Delete a folder","action":"Delete a folder"},{"name":"List","value":"list","description":"Return the files and folders in a given folder","action":"List a folder"},{"name":"Move","value":"move","description":"Move a folder","action":"Move a folder"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["search"]}},"options":[{"name":"Query","value":"query","action":"Query"}],"default":"query"},{"displayName":"From Path","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["copy"],"resource":["file","folder"]}},"placeholder":"/invoices/original.txt","description":"The path of file or folder to copy"},{"displayName":"To Path","name":"toPath","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["copy"],"resource":["file","folder"]}},"placeholder":"/invoices/copy.txt","description":"The destination path of file or folder"},{"displayName":"Delete Path","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["file","folder"]}},"placeholder":"/invoices/2019/invoice_1.pdf","description":"The path to delete. Can be a single file or a whole folder."},{"displayName":"From Path","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["move"],"resource":["file","folder"]}},"placeholder":"/invoices/old_name.txt","description":"The path of file or folder to move"},{"displayName":"To Path","name":"toPath","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["move"],"resource":["file","folder"]}},"placeholder":"/invoices/new_name.txt","description":"The new path of file or folder"},{"displayName":"File Path","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["download"],"resource":["file"]}},"placeholder":"/invoices/2019/invoice_1.pdf","description":"The file path of the file to download. Has to contain the full path."},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","required":true,"default":"data","displayOptions":{"show":{"operation":["download"],"resource":["file"]}},"description":"Name of the binary property to which to write the data of the read file"},{"displayName":"File Path","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"]}},"placeholder":"/invoices/2019/invoice_1.pdf","description":"The file path of the file to upload. Has to contain the full path. The parent folder has to exist. Existing files get overwritten."},{"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":"File Content","name":"fileContent","type":"string","default":"","displayOptions":{"show":{"operation":["upload"],"resource":["file"],"binaryData":[false]}},"placeholder":"","description":"The text content of the file to upload"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"],"binaryData":[true]}},"placeholder":"","description":"Name of the binary property which contains the data for the file to be uploaded"},{"displayName":"Query","name":"query","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["query"],"resource":["search"]}},"description":"The string to search for. May match across multiple fields based on the request arguments."},{"displayName":"File Status","name":"fileStatus","type":"options","options":[{"name":"Active","value":"active"},{"name":"Deleted","value":"deleted"}],"default":"active","displayOptions":{"show":{"operation":["query"],"resource":["search"]}},"description":"The string to search for. May match across multiple fields based on the request arguments."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["query"],"resource":["search"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["search"],"operation":["query"],"returnAll":[false]}},"default":100,"description":"Max number of results to return"},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"operation":["query"],"resource":["search"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["search"],"operation":["query"]}},"options":[{"displayName":"File Categories","name":"file_categories","type":"multiOptions","options":[{"name":"Audio (mp3, qav, mid, etc.)","value":"audio"},{"name":"Document (doc, docx, txt, etc.)","value":"document"},{"name":"Dropbox Paper","value":"paper"},{"name":"Folder","value":"folder"},{"name":"Image (jpg, png, gif, etc.)","value":"image"},{"name":"Other","value":"other"},{"name":"PDF","value":"pdf"},{"name":"Presentation (ppt, pptx, key, etc.)","value":"presentation"},{"name":"Spreadsheet (xlsx, xls, csv, etc.)","value":"spreadsheet"},{"name":"Video (avi, wmv, mp4, etc.)","value":"video"}],"default":[]},{"displayName":"File Extensions","name":"file_extensions","type":"string","default":"","description":"Multiple file extensions can be set separated by comma. Example: jpg,pdf."},{"displayName":"Folder","name":"path","type":"string","default":"","description":"If this field is not specified, this module searches the entire Dropbox"}]},{"displayName":"Folder","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["folder"]}},"placeholder":"/invoices/2019","description":"The folder to create. The parent folder has to exist."},{"displayName":"Folder Path","name":"path","type":"string","default":"","displayOptions":{"show":{"operation":["list"],"resource":["folder"]}},"placeholder":"/invoices/2019/","description":"The path of which to list the content"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["list"],"resource":["folder"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["folder"],"operation":["list"],"returnAll":[false]}},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["folder"],"operation":["list"]}},"options":[{"displayName":"Include Deleted","name":"include_deleted","type":"boolean","default":false,"description":"Whether the results will include entries for files and folders that used to exist but were deleted. The default for this field is False."},{"displayName":"Include Shared Members","name":"include_has_explicit_shared_members","type":"boolean","default":false,"description":"Whether the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False."},{"displayName":"Include Mounted Folders","name":"include_mounted_folders","type":"boolean","default":true,"description":"Whether the results will include entries under mounted folders which includes app folder, shared folder and team folder. The default for this field is True."},{"displayName":"Include Non Downloadable Files","name":"include_non_downloadable_files","type":"boolean","default":true,"description":"Whether to include files that are not downloadable, i.e. Google Docs. The default for this field is True."},{"displayName":"Recursive","name":"recursive","type":"boolean","default":false,"description":"Whether the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is False."}]}]

operations:
  [{"type":"resource","resource":"file","name":"File"},{"type":"resource","resource":"folder","name":"Folder"},{"type":"resource","resource":"search","name":"Search"},{"type":"operation","operation":"copy","name":"Copy","action":"Copy a file","resources":["file"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a file","resources":["file"]},{"type":"operation","operation":"download","name":"Download","action":"Download a file","resources":["file"]},{"type":"operation","operation":"move","name":"Move","action":"Move a file","resources":["file"]},{"type":"operation","operation":"upload","name":"Upload","action":"Upload a file","resources":["file"]},{"type":"operation","operation":"copy","name":"Copy","action":"Copy a folder","resources":["folder"]},{"type":"operation","operation":"create","name":"Create","action":"Create a folder","resources":["folder"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a folder","resources":["folder"]},{"type":"operation","operation":"list","name":"List","action":"List a folder","resources":["folder"]},{"type":"operation","operation":"move","name":"Move","action":"Move a folder","resources":["folder"]},{"type":"operation","operation":"query","name":"Query","action":"Query","resources":["search"]}]

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


node_type: dropcontact
package_name: n8n-nodes-base
display_name: Dropcontact
description: Find B2B emails and enrich contacts
category: transform
development_style: programmatic
version: 1
operations: [{"type":"resource","resource":"contact","name":"Contact"}]
credentials_required: [{"name":"dropcontactApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Dropcontact node documentation
  description: Learn how to use the Dropcontact node in n8n. Follow technical documentation to integrate Dropcontact node into your workflows.
  contentType: [integration, reference]
  ---

  # Dropcontact node

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

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

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

  ## Operations

  **Contact**
  - Enrich
  - Fetch Request

  ## Templates and examples

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

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

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


node_type: editImage
package_name: n8n-nodes-base
display_name: Edit Image
description: Edits an image like blur, resize or adding border and text
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Edit Image
  description: Documentation for the Edit Image node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Edit Image

  Use the Edit Image node to manipulate and edit images.

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

  ## Operations

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

  ## Node parameters

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

  ### Blur parameters

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

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

  ### Border parameters

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

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

  ### Composite parameters

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

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

  ### Create parameters

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

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

  ### Crop parameters

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

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

  ### Draw parameters

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

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

  ### Get Information parameters

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

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

  ### Multi Step parameters

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

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

  ### Resize parameters

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

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

  ### Rotate parameters

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

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

  ### Shear parameters

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

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

  ### Text parameters

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

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

  ### Transparent parameters

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

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

  ## Node options

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

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

  ## Templates and examples

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

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


node_type: e2eTest
package_name: n8n-nodes-base
display_name: E2E Test
description: Dummy node used for e2e testing
category: output
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":"Remote Options","value":"remoteOptions"},{"name":"Resource Locator","value":"resourceLocator"},{"name":"Resource Mapping Component","value":"resourceMapper"}],"default":"remoteOptions"},{"displayName":"Field ID","name":"fieldId","type":"string","default":""},{"displayName":"Remote Options Name or ID","name":"remoteOptions","description":"Remote options to load. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","type":"options","typeOptions":{"loadOptionsDependsOn":["fieldId"],"loadOptionsMethod":"getOptions"},"required":true,"default":[],"displayOptions":{"show":{"operation":["remoteOptions"]}}},{"displayName":"Resource Locator","name":"rlc","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"displayOptions":{"show":{"operation":["resourceLocator"]}},"modes":[{"displayName":"From List","name":"list","type":"list","typeOptions":{"searchListMethod":"optionsSearch","searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://example.com/user/a4071e98-7d40-41fb-8911-ce3e7bf94fb2","validation":[{"type":"regex","properties":{"regex":"https://example.com/user/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}","errorMessage":"Not a valid example URL"}}],"extractValue":{"type":"regex","regex":"https://example.com/user/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}","errorMessage":"Not a valid UUI"}}],"placeholder":"a4071e98-7d40-41fb-8911-ce3e7bf94fb2"}]},{"displayName":"Resource Mapping Component","name":"resourceMapper","type":"resourceMapper","noDataExpression":true,"default":{"mappingMode":"defineBelow","value":null},"required":true,"typeOptions":{"loadOptionsDependsOn":["fieldId"],"resourceMapper":{"resourceMapperMethod":"getMappingColumns","mode":"upsert","fieldWords":{"singular":"column","plural":"columns"},"addAllFields":true,"multiKeyMatch":false}},"displayOptions":{"show":{"operation":["resourceMapper"]}}},{"displayName":"Other Non Important Field","name":"otherField","type":"string","default":""}]


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

  # E-goi node

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

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

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

  ## Operations

  **Contact**

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

  ## Templates and examples

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

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


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

  # Elasticsearch node

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

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"document","name":"Document"},{"type":"resource","resource":"index","name":"Index"},{"type":"operation","operation":"create","name":"Create","action":"Create a document","resources":["document"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a document","resources":["document"]},{"type":"operation","operation":"get","name":"Get","action":"Get a document","resources":["document"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many documents","resources":["document"]},{"type":"operation","operation":"update","name":"Update","action":"Update a document","resources":["document"]},{"type":"operation","operation":"create","name":"Create","action":"Create an index","resources":["index"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an index","resources":["index"]},{"type":"operation","operation":"get","name":"Get","action":"Get an index","resources":["index"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many indices","resources":["index"]}]


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

  # Elastic Security node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"case","name":"Case"},{"type":"resource","resource":"caseComment","name":"Case Comment"},{"type":"resource","resource":"caseTag","name":"Case Tag"},{"type":"resource","resource":"connector","name":"Connector"},{"type":"operation","operation":"create","name":"Create","action":"Create a case","resources":["case"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a case","resources":["case"]},{"type":"operation","operation":"get","name":"Get","action":"Get a case","resources":["case"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many cases","resources":["case"]},{"type":"operation","operation":"getStatus","name":"Get Status","action":"Get the status of a case","resources":["case"]},{"type":"operation","operation":"update","name":"Update","action":"Update a case","resources":["case"]},{"type":"operation","operation":"add","name":"Add","action":"Add a comment to a case","resources":["caseComment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a case comment","resources":["caseComment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many case comments","resources":["caseComment"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a comment from a case","resources":["caseComment"]},{"type":"operation","operation":"update","name":"Update","action":"Update a comment from a case","resources":["caseComment"]},{"type":"operation","operation":"add","name":"Add","action":"Add a tag to a case","resources":["caseTag"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a tag from a case","resources":["caseTag"]},{"type":"operation","operation":"create","name":"Create","action":"Create a connector","resources":["connector"]}]


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

  # Emelia node

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

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

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

  ## Operations

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

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Campaign","value":"campaign"},{"name":"Contact List","value":"contactList"}],"default":"campaign","required":true},{"displayName":"Operation","name":"operation","type":"options","default":"get","noDataExpression":true,"options":[{"name":"Add Contact","value":"addContact","action":"Add a contact to a campaign"},{"name":"Create","value":"create","action":"Create a campaign"},{"name":"Duplicate","value":"duplicate","action":"Duplicate a campaign"},{"name":"Get","value":"get","action":"Get a campaign"},{"name":"Get Many","value":"getAll","action":"Get many campaigns"},{"name":"Pause","value":"pause","action":"Pause a campaign"},{"name":"Start","value":"start","action":"Start a campaign"}],"displayOptions":{"show":{"resource":["campaign"]}}},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","typeOptions":{"loadOptionsMethod":"getCampaigns"},"default":[],"required":true,"description":"The ID of the campaign to add the contact to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["campaign"],"operation":["addContact"]}}},{"displayName":"Contact Email","name":"contactEmail","type":"string","required":true,"default":"","description":"The email of the contact to add to the campaign","displayOptions":{"show":{"resource":["campaign"],"operation":["addContact"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["campaign"],"operation":["addContact"]}},"options":[{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name","name":"fieldName","type":"string","default":"","description":"The name of the field to add custom field to"},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the contact to add"},{"displayName":"Last Contacted","name":"lastContacted","type":"dateTime","default":"","description":"Last contacted date of the contact to add"},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Last name of the contact to add"},{"displayName":"Last Open","name":"lastOpen","type":"dateTime","default":"","description":"Last opened date of the contact to add"},{"displayName":"Last Replied","name":"lastReplied","type":"dateTime","default":"","description":"Last replied date of the contact to add"},{"displayName":"Mails Sent","name":"mailsSent","type":"number","default":0,"description":"Number of emails sent to the contact to add"},{"displayName":"Phone Number","name":"phoneNumber","type":"string","default":"","description":"Phone number of the contact to add"}]},{"displayName":"Campaign Name","name":"campaignName","type":"string","required":true,"default":"","description":"The name of the campaign to create","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}}},{"displayName":"Campaign ID","name":"campaignId","type":"string","default":"","required":true,"description":"The ID of the campaign to retrieve","displayOptions":{"show":{"resource":["campaign"],"operation":["get"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["campaign"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":100,"description":"Max number of results to return","typeOptions":{"minValue":1,"maxValue":100},"displayOptions":{"show":{"resource":["campaign"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Campaign ID","name":"campaignId","type":"string","default":"","required":true,"description":"The ID of the campaign to pause. The campaign must be in RUNNING mode.","displayOptions":{"show":{"resource":["campaign"],"operation":["pause"]}}},{"displayName":"Campaign ID","name":"campaignId","type":"string","default":"","required":true,"description":"The ID of the campaign to start. Email provider and contacts must be set.","displayOptions":{"show":{"resource":["campaign"],"operation":["start"]}}},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","default":"","required":true,"description":"The ID of the campaign to duplicate. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","typeOptions":{"loadOptionsMethod":"getCampaigns"},"displayOptions":{"show":{"resource":["campaign"],"operation":["duplicate"]}}},{"displayName":"New Campaign Name","name":"campaignName","type":"string","required":true,"default":"","description":"The name of the new campaign to create","displayOptions":{"show":{"resource":["campaign"],"operation":["duplicate"]}}},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["duplicate"],"resource":["campaign"]}},"options":[{"displayName":"Copy Contacts","name":"copyContacts","type":"boolean","default":false,"description":"Whether to copy all the contacts from the original campaign"},{"displayName":"Copy Email Provider","name":"copyProvider","type":"boolean","default":true,"description":"Whether to set the same email provider than the original campaign"},{"displayName":"Copy Email Sequence","name":"copyMails","type":"boolean","default":true,"description":"Whether to copy all the steps of the email sequence from the original campaign"},{"displayName":"Copy Global Settings","name":"copySettings","type":"boolean","default":true,"description":"Whether to copy all the general settings from the original campaign"}]},{"displayName":"Operation","name":"operation","type":"options","default":"getAll","noDataExpression":true,"options":[{"name":"Add","value":"add","action":"Add a contact list"},{"name":"Get Many","value":"getAll","action":"Get many contact lists"}],"displayOptions":{"show":{"resource":["contactList"]}}},{"displayName":"Contact List Name or ID","name":"contactListId","type":"options","typeOptions":{"loadOptionsMethod":"getContactLists"},"default":[],"required":true,"description":"The ID of the contact list to add the contact to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["contactList"],"operation":["add"]}}},{"displayName":"Contact Email","name":"contactEmail","type":"string","required":true,"default":"","description":"The email of the contact to add to the contact list","displayOptions":{"show":{"resource":["contactList"],"operation":["add"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contactList"],"operation":["add"]}},"options":[{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name","name":"fieldName","type":"string","default":"","description":"The name of the field to add custom field to"},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the contact to add"},{"displayName":"Last Contacted","name":"lastContacted","type":"dateTime","default":"","description":"Last contacted date of the contact to add"},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Last name of the contact to add"},{"displayName":"Last Open","name":"lastOpen","type":"dateTime","default":"","description":"Last opened date of the contact to add"},{"displayName":"Last Replied","name":"lastReplied","type":"dateTime","default":"","description":"Last replied date of the contact to add"},{"displayName":"Mails Sent","name":"mailsSent","type":"number","default":0,"description":"Number of emails sent to the contact to add"},{"displayName":"Phone Number","name":"phoneNumber","type":"string","default":"","description":"Phone number of the contact to add"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["contactList"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":100,"description":"Max number of results to return","typeOptions":{"minValue":1,"maxValue":100},"displayOptions":{"show":{"resource":["contactList"],"operation":["getAll"],"returnAll":[false]}}}]

operations:
  [{"type":"resource","resource":"campaign","name":"Campaign"},{"type":"resource","resource":"contactList","name":"Contact List"},{"type":"operation","operation":"addContact","name":"Add Contact","action":"Add a contact to a campaign","resources":["campaign"]},{"type":"operation","operation":"create","name":"Create","action":"Create a campaign","resources":["campaign"]},{"type":"operation","operation":"duplicate","name":"Duplicate","action":"Duplicate a campaign","resources":["campaign"]},{"type":"operation","operation":"get","name":"Get","action":"Get a campaign","resources":["campaign"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many campaigns","resources":["campaign"]},{"type":"operation","operation":"pause","name":"Pause","action":"Pause a campaign","resources":["campaign"]},{"type":"operation","operation":"start","name":"Start","action":"Start a campaign","resources":["campaign"]},{"type":"operation","operation":"add","name":"Add","action":"Add a contact list","resources":["contactList"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contact lists","resources":["contactList"]}]


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

  # Emelia Trigger node

  [Emelia](https://emelia.io){:target=_blank .external-link} is a cold-mailing tool.

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

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

  ## Events

  - Email Bounced
  - Email Opened
  - Email Replied
  - Email Sent
  - Link Clicked
  - Unsubscribed Contact

properties_schema:
  [{"displayName":"Campaign Name or ID","name":"campaignId","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":"getCampaigns"},"required":true,"default":""},{"displayName":"Events","name":"events","type":"multiOptions","required":true,"default":[],"options":[{"name":"Email Bounced","value":"bounced"},{"name":"Email Opened","value":"opened"},{"name":"Email Replied","value":"replied"},{"name":"Email Sent","value":"sent"},{"name":"Link Clicked","value":"clicked"},{"name":"Unsubscribed Contact","value":"unsubscribed"}]}]


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

  # ERPNext node

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

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

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

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

  ## Operations

  **Document**
  - Create a document
  - Delete a document
  - Retrieve a document
  - Retrieve all documents
  - Update a document

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Document","value":"document"}],"default":"document"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["document"]}},"options":[{"name":"Create","value":"create","description":"Create a document","action":"Create a document"},{"name":"Delete","value":"delete","description":"Delete a document","action":"Delete a document"},{"name":"Get","value":"get","description":"Retrieve a document","action":"Get a document"},{"name":"Get Many","value":"getAll","description":"Retrieve many documents","action":"Get many documents"},{"name":"Update","value":"update","description":"Update a document","action":"Update a document"}],"default":"create"},{"displayName":"DocType Name or ID","name":"docType","type":"options","typeOptions":{"loadOptionsMethod":"getDocTypes"},"default":"","description":"DocType whose documents to retrieve. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","placeholder":"Customer","displayOptions":{"show":{"resource":["document"],"operation":["getAll"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"description":"Whether to return all results or only up to a given limit","displayOptions":{"show":{"resource":["document"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","typeOptions":{"minValue":1},"default":10,"description":"Max number of results to return","displayOptions":{"show":{"resource":["document"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["document"],"operation":["getAll"]}},"options":[{"displayName":"Field Names or IDs","name":"fields","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getDocFilters","loadOptionsDependsOn":["docType"]},"default":[],"description":"Comma-separated list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","placeholder":"name,country"},{"displayName":"Filters","name":"filters","type":"fixedCollection","default":{},"placeholder":"Add Filter","description":"Custom Properties","typeOptions":{"multipleValues":true},"options":[{"displayName":"Property","name":"customProperty","values":[{"displayName":"Field Name or ID","name":"field","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getDocFields","loadOptionsDependsOn":["docType"]},"default":""},{"displayName":"Operator","name":"operator","type":"options","default":"is","options":[{"name":"EQUALS, or GREATER","value":"equalsGreater"},{"name":"EQUALS, or LESS","value":"equalsLess"},{"name":"IS","value":"is"},{"name":"IS GREATER","value":"greater"},{"name":"IS LESS","value":"less"},{"name":"IS NOT","value":"isNot"}]},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the operator condition"}]}]}]},{"displayName":"DocType Name or ID","name":"docType","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getDocTypes"},"required":true,"description":"DocType you would like to create. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","placeholder":"Customer","displayOptions":{"show":{"resource":["document"],"operation":["create"]}}},{"displayName":"Properties","name":"properties","type":"fixedCollection","placeholder":"Add Property","required":true,"default":{},"typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["document"],"operation":["create"]}},"options":[{"displayName":"Property","name":"customProperty","placeholder":"Add Property","values":[{"displayName":"Field Name or ID","name":"field","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getDocFields","loadOptionsDependsOn":["docType"]},"default":[]},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"DocType Name or ID","name":"docType","type":"options","typeOptions":{"loadOptionsMethod":"getDocTypes"},"default":"","description":"The type of document you would like to get. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["document"],"operation":["get"]}},"required":true},{"displayName":"Document Name","name":"documentName","type":"string","default":"","description":"The name (ID) of document you would like to get","displayOptions":{"show":{"resource":["document"],"operation":["get"]}},"required":true},{"displayName":"DocType Name or ID","name":"docType","type":"options","typeOptions":{"loadOptionsMethod":"getDocTypes"},"default":"","description":"The type of document you would like to delete. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["document"],"operation":["delete"]}},"required":true},{"displayName":"Document Name","name":"documentName","type":"string","default":"","description":"The name (ID) of document you would like to get","displayOptions":{"show":{"resource":["document"],"operation":["delete"]}},"required":true},{"displayName":"DocType Name or ID","name":"docType","type":"options","typeOptions":{"loadOptionsMethod":"getDocTypes"},"default":"","description":"The type of document you would like to update. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["document"],"operation":["update"]}},"required":true},{"displayName":"Document Name","name":"documentName","type":"string","default":"","description":"The name (ID) of document you would like to get","displayOptions":{"show":{"resource":["document"],"operation":["update"]}},"required":true},{"displayName":"Properties","name":"properties","type":"fixedCollection","placeholder":"Add Property","description":"Properties of request body","default":{},"typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["document"],"operation":["update"]}},"options":[{"displayName":"Property","name":"customProperty","values":[{"displayName":"Field Name or ID","name":"field","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getDocFields","loadOptionsDependsOn":["docType"]},"default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]}]

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


node_type: errorTrigger
package_name: n8n-nodes-base
display_name: Error Trigger
description: Triggers the workflow when another workflow has an error
category: trigger
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: Error Trigger node documentation
  description: Learn how to use the Error Trigger node in n8n. Follow technical documentation to integrate Error Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Error Trigger node

  You can use the Error Trigger node to create error workflows. When another linked workflow fails, this node gets details about the failed workflow and the errors, and runs the error workflow.

  ## Usage

  --8<-- "_snippets/flow-logic/create-set-error-workflow.md"


  Note the following:

  * If a workflow uses the Error Trigger node, you don't have to activate the workflow.
  * If a workflow contains the Error Trigger node, by default, the workflow uses itself as the error workflow.
  * You can't test error workflows when running workflows manually. The Error Trigger only runs when an automatic workflow errors.

  ## Templates and examples

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

  ## Related resources

  You can use the [Stop And Error](/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror.md) node to send custom messages to the Error Trigger.

  Read more about [Error workflows](/flow-logic/error-handling.md) in n8n workflows. 

  ## Error data

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

properties_schema:
  [{"displayName":"This node will trigger when there is an error in another workflow, as long as that workflow is set up to do so. <a href=\"https://docs.n8n.io/integrations/core-nodes/n8n-nodes-base.errortrigger\" target=\"_blank\">More info<a>","name":"notice","type":"notice","default":""}]


node_type: eventbriteTrigger
package_name: n8n-nodes-base
display_name: Eventbrite Trigger
description: Handle Eventbrite events via webhooks
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: Eventbrite Trigger node documentation
  description: Learn how to use the Eventbrite Trigger node in n8n. Follow technical documentation to integrate Eventbrite Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Eventbrite Trigger node

  [Eventbrite](https://www.eventbrite.com/){:target=_blank .external-link} is an event management and ticketing website. The service allows users to browse, create, and promote local events.

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"Private Key","value":"privateKey"},{"name":"OAuth2","value":"oAuth2"}],"default":"privateKey"},{"displayName":"Organization Name or ID","name":"organization","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","description":"The Eventbrite Organization to work on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Event Name or ID","name":"event","type":"options","required":true,"typeOptions":{"loadOptionsDependsOn":["organization"],"loadOptionsMethod":"getEvents"},"default":"","description":"Limit the triggers to this event. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Actions","name":"actions","type":"multiOptions","options":[{"name":"attendee.checked_in","value":"attendee.checked_in"},{"name":"attendee.checked_out","value":"attendee.checked_out"},{"name":"attendee.updated","value":"attendee.updated"},{"name":"event.created","value":"event.created"},{"name":"event.published","value":"event.published"},{"name":"event.unpublished","value":"event.unpublished"},{"name":"event.updated","value":"event.updated"},{"name":"order.placed","value":"order.placed"},{"name":"order.refunded","value":"order.refunded"},{"name":"order.updated","value":"order.updated"},{"name":"organizer.updated","value":"organizer.updated"},{"name":"ticket_class.created","value":"ticket_class.created"},{"name":"ticket_class.deleted","value":"ticket_class.deleted"},{"name":"ticket_class.updated","value":"ticket_class.updated"},{"name":"venue.updated","value":"venue.updated"}],"required":true,"default":[],"description":"One or more action to subscribe to"},{"displayName":"Resolve Data","name":"resolveData","type":"boolean","default":true,"description":"By default does the webhook-data only contain the URL to receive the object data manually. If this option gets activated, it will resolve the data automatically."}]

credentials_required:
  [{"name":"eventbriteApi","required":true,"displayOptions":{"show":{"authentication":["privateKey"]}}},{"name":"eventbriteOAuth2Api","required":true,"displayOptions":{"show":{"authentication":["oAuth2"]}}}]


node_type: executeCommand
package_name: n8n-nodes-base
display_name: Execute Command
description: Executes a command on the host
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: Execute Command
  description: Documentation for the Execute Command node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # Execute Command

  The Execute Command node runs shell commands on the host machine that runs n8n.

  /// note | Which shell runs the command?
  This node executes the command in the default shell of the host machine. For example, `cmd` on Windows and `zsh` on macOS.

  If you run n8n with Docker, your command will run in the n8n container and not the Docker host.
  ///

  /// note | Not available on Cloud
  This node isn't available on n8n Cloud.
  ///

  ## Node parameters

  Configure the node using the following parameters.

  ### Execute Once

  Choose whether you want the node to execute only once (turned on) or once for every item it receives as input (turned off).

  ### Command

  Enter the command to execute on the host machine. Refer to sections below for examples of running [multiple commands](#run-multiple-commands) and [cURL commands](#run-curl-command).

  #### Run multiple commands

  Use one of two methods to run multiple commands in one Execute Command node:

  * Enter each command on one line separated by `&&`. For example, you can combine the change directory (cd) command with the list (ls) command using `&&`.

      ```bash
      cd bin && ls
      ```

  * Enter each command on a separate line. For example, you can write the list (ls) command on a new line after the change directory (cd) command.

      ```bash
      cd bin
      ls
      ```

  #### Run cURL command

  You can also use the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node to make a cURL request.

  If you want to run the curl command in the Execute Command node, you will have to build a Docker image based on the existing n8n image. The default n8n Docker image uses Alpine Linux. You will have to install the curl package.

  1. Create a file named `Dockerfile`.
  2. Add the below code snippet to the Dockerfile.

      ```shell
      FROM docker.n8n.io/n8nio/n8n
      USER root
      RUN apk --update add curl
      USER node
      ```

  3. In the same folder, execute the command below to build the Docker image.

      ```shell
      docker build -t n8n-curl
      ```

  4. Replace the Docker image you used before. For example, replace `docker.n8n.io/n8nio/n8n` with `n8n-curl`.
  5. Run the newly created Docker image. You'll now be able to execute ssh using the Execute Command Node.

  ## Templates and examples

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

  ## Common issues

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

properties_schema:
  [{"displayName":"Execute Once","name":"executeOnce","type":"boolean","default":true,"description":"Whether to execute only once instead of once for each entry"},{"displayName":"Command","name":"command","typeOptions":{"rows":5},"type":"string","default":"","placeholder":"echo \"test\"","description":"The command to execute","required":true}]


node_type: executeWorkflow
package_name: n8n-nodes-base
display_name: Execute Workflow
description: Execute another workflow
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: Execute Sub-workflow
  description: Documentation for the Execute Sub-workflow node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # Execute Sub-workflow

  Use the Execute Sub-workflow node to run a different workflow on the host machine that runs n8n.

  ## Node parameters

  ### Source

  Select where the node should get the sub-workflow's information from:

  - **Database**: Select this option to load the workflow from the database by ID. You must also enter either:
  	- **From list**: Select the workflow from a list of workflows available to your account.
  	- **Workflow ID**: Enter the ID for the workflow. The URL of the workflow contains the ID after `/workflow/`. For example, if the URL of a workflow is `https://my-n8n-acct.app.n8n.cloud/workflow/abCDE1f6gHiJKL7`, the **Workflow ID** is `abCDE1f6gHiJKL7`.
  - **Local File**: Select this option to load the workflow from a locally saved JSON file. You must also enter:
  	- **Workflow Path**: Enter the path to the local JSON workflow file you want the node to execute.
  - **Parameter**: Select this option to load the workflow from a parameter. You must also enter:
  	- **Workflow JSON**: Enter the JSON code you want the node to execute.
  - **URL**: Select this option to load the workflow from a URL. You must also enter:
  	- **Workflow URL**: Enter the URL you want to load the workflow from.

  ### Workflow Inputs

  If you select a sub-workflow using the **database** and **From list** options, the sub-workflow's input items will automatically display, ready for you to fill in or map values.

  You can optionally remove requested input items, in which case the sub-workflow receives `null` as the item's value. You can also enable **Attempt to convert types** to try to automatically convert data to the sub-workflow item's requested type.

  Input items won't appear if the sub-workflow's Workflow Input Trigger node uses the "Accept all data" input data mode.

  ### Mode

  Use this parameter to control the execution mode for the node. Choose from these options:

  - **Run once with all items**: Pass all input items into a single execution of the node.
  - **Run once for each item**: Execute the node once for each input item in turn.

  ## Node options

  This node includes one option: **Wait for Sub-Workflow Completion**. This lets you control whether the main workflow should wait for the sub-workflow's completion before moving on to the next step (turned on) or whether the main workflow should continue without waiting (turned off).

  ## Templates and examples

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

  ## Set up and use a sub-workflow

  This section walks through setting up both the parent workflow and sub-workflow.

  --8<-- "_snippets/flow-logic/subworkflow-usage.md"


  ## How data passes between workflows

  --8<-- "_snippets/flow-logic/subworkflow-data-flow.md"

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"hidden","noDataExpression":true,"default":"call_workflow","options":[{"name":"Call Another Workflow","value":"call_workflow"}]},{"displayName":"Source","name":"source","type":"options","options":[{"name":"Database","value":"database","description":"Load the workflow from the database by ID"},{"name":"Local File","value":"localFile","description":"Load the workflow from a locally saved file"},{"name":"Parameter","value":"parameter","description":"Load the workflow from a parameter"},{"name":"URL","value":"url","description":"Load the workflow from an URL"}],"default":"database","description":"Where to get the workflow to execute from"},{"displayName":"Workflow ID","name":"workflowId","type":"string","displayOptions":{"show":{"source":["database"]}},"default":"","required":true,"hint":"Can be found in the URL of the workflow","description":"Note on using an expression here: if this node is set to run once with all items, they will all be sent to the <em>same</em> workflow. That workflow's ID will be calculated by evaluating the expression for the <strong>first input item</strong>."},{"displayName":"Workflow Path","name":"workflowPath","type":"string","displayOptions":{"show":{"source":["localFile"]}},"default":"","placeholder":"/data/workflow.json","required":true,"description":"The path to local JSON workflow file to execute"},{"displayName":"Workflow JSON","name":"workflowJson","type":"string","typeOptions":{"editor":"json","rows":10},"displayOptions":{"show":{"source":["parameter"]}},"default":"\n\n\n","required":true,"description":"The workflow JSON code to execute"},{"displayName":"Workflow URL","name":"workflowUrl","type":"string","displayOptions":{"show":{"source":["url"]}},"default":"","placeholder":"https://example.com/workflow.json","required":true,"description":"The URL from which to load the workflow from"},{"displayName":"Any data you pass into this node will be output by the Execute Workflow Trigger. <a href=\"https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/\" target=\"_blank\">More info</a>","name":"executeWorkflowNotice","type":"notice","default":""},{"displayName":"Mode","name":"mode","type":"options","noDataExpression":true,"options":[{"name":"Run once with all items","value":"once","description":"Pass all items into a single execution of the sub-workflow"},{"name":"Run once for each item","value":"each","description":"Call the sub-workflow individually for each item"}],"default":"once"}]


node_type: executeWorkflowTrigger
package_name: n8n-nodes-base
display_name: Execute Workflow Trigger
description: Helpers for calling other n8n workflows. Used for designing modular, microservice-like workflows.
category: trigger
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: Execute Sub-workflow Trigger node documentation
  description: Learn how to use the Execute Sub-workflow Trigger node in n8n. Follow technical documentation to integrate Execute Sub-workflow Trigger node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Execute Sub-workflow Trigger node

  Use this node to start a workflow in response to another workflow. It should be the first node in the workflow.

  n8n allows you to call workflows from other workflows. This is useful if you want to:

  * Reuse a workflow: for example, you could have multiple workflows pulling and processing data from different sources, then have all those workflows call a single workflow that generates a report.
  * Break large workflows into smaller components.

  ## Usage

  This node runs in response to a call from the [Execute Sub-workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) or [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) nodes.

  --8<-- "_snippets/flow-logic/subworkflow-usage.md"

  ## Templates and examples

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

  ## How data passes between workflows

  --8<-- "_snippets/flow-logic/subworkflow-data-flow.md"

properties_schema:
  [{"displayName":"When an ‘execute workflow’ node calls this workflow, the execution starts here. Any data passed into the 'execute workflow' node will be output by this node.","name":"notice","type":"notice","default":""},{"displayName":"Events","name":"events","type":"hidden","noDataExpression":true,"options":[{"name":"Workflow Call","value":"worklfow_call","description":"When called by another workflow using Execute Workflow Trigger","action":"When Called by Another Workflow"}],"default":"worklfow_call"}]


node_type: executionData
package_name: n8n-nodes-base
display_name: Execution Data
description: Add execution data for search
category: input
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: Execution Data
  description: Documentation for the Execution Data node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # Execution Data

  Use this node to save metadata for workflow executions. You can then search by this data in the **Executions** list.

  You can retrieve custom execution data during workflow execution using the Code node. Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information.

  /// info | Feature availability
  Available on Pro and Enterprise plans.
  ///

  ## Operations

  * Save Execution Data for Search

  ## Data to Save

  Add a **Saved Field** for each key/value pair of metadata you'd like to save.

  ## Limitations

  The Execution Data node has the following restrictions when storing execution metadata:

  * `key`: limited to 50 characters
  * `value`: limited to 512 characters

  If either the `key` or `value` exceed the above limitations, n8n truncates to their maximum length and outputs a log entry.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Use this node to save fields you want to use later to easily find an execution (e.g. a user ID). You'll be able to search by this data in the 'executions' tab.<br>This feature is available on our Pro and Enterprise plans. <a href='https://n8n.io/pricing/' target='_blank'>More Info</a>.","name":"notice","type":"notice","default":""},{"displayName":"Operation","name":"operation","type":"options","default":"save","noDataExpression":true,"options":[{"name":"Save Execution Data for Search","value":"save","action":"Save execution data for search"}]},{"displayName":"Data to Save","name":"dataToSave","placeholder":"Add Saved Field","type":"fixedCollection","typeOptions":{"multipleValueButtonText":"Add Saved Field","multipleValues":true},"displayOptions":{"show":{"operation":["save"]}},"default":{},"options":[{"displayName":"Values","name":"values","values":[{"displayName":"Key","name":"key","type":"string","default":"","placeholder":"e.g. myKey"},{"displayName":"Value","name":"value","type":"string","default":"","placeholder":"e.g. myValue"}]}]}]


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

  # Facebook Graph API node

  Use the Facebook Graph API node to automate work in Facebook Graph API, and integrate Facebook Graph API with other applications. n8n has built-in support for a wide range of Facebook Graph API features, including using queries GET POST DELETE for several parameters like host URL, request methods and much more.

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

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

  ## Operations

  * **Default**
      * GET
      * POST
      * DELETE 
  * **Video Uploads**
      * GET
      * POST
      * DELETE 


  ### Parameters

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

  * **Host URL**: The host URL for the request. The following options are available:
      * **Default**: Requests are passed to the `graph.facebook.com` host URL. Used for the majority of requests.
      * **Video**: Requests are passed to the `graph-video.facebook.com` host URL. Used for video upload requests only.
  * **HTTP Request Method**: The method to be used for this request, from the following options:
      * **GET**
      * **POST**
      * **DELETE**
  * **Graph API Version**: The version of the [Facebook Graph API](https://developers.facebook.com/docs/graph-api/changelog) to be used for this request.
  * **Node**: The node on which to operate, for example `/<page-id>/feed`. Read more about it in the [official Facebook Developer documentation](https://developers.facebook.com/docs/graph-api/using-graph-api).
  * **Edge**: Edge of the node on which to operate. Edges represent collections of objects which are attached to the node.
  * **Ignore SSL Issues**: Toggle to still download the response even if SSL certificate validation isn't possible.
  * **Send Binary File**: Available for `POST` operations. If enabled binary data is sent as the body. Requires setting the following:
      * **Input Binary Field**: Name of the binary property which contains the data for the file to be uploaded.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Host URL","name":"hostUrl","type":"options","options":[{"name":"Default","value":"graph.facebook.com"},{"name":"Video Uploads","value":"graph-video.facebook.com"}],"default":"graph.facebook.com","description":"The Host URL of the request. Almost all requests are passed to the graph.facebook.com host URL. The single exception is video uploads, which use graph-video.facebook.com.","required":true},{"displayName":"HTTP Request Method","name":"httpRequestMethod","type":"options","options":[{"name":"GET","value":"GET"},{"name":"POST","value":"POST"},{"name":"DELETE","value":"DELETE"}],"default":"GET","description":"The HTTP Method to be used for the request","required":true},{"displayName":"Graph API Version","name":"graphApiVersion","type":"options","options":[{"name":"Default","value":""},{"name":"v17.0","value":"v17.0"},{"name":"v16.0","value":"v16.0"},{"name":"v15.0","value":"v15.0"},{"name":"v14.0","value":"v14.0"},{"name":"v13.0","value":"v13.0"},{"name":"v12.0","value":"v12.0"},{"name":"v11.0","value":"v11.0"},{"name":"v10.0","value":"v10.0"},{"name":"v9.0","value":"v9.0"},{"name":"v8.0","value":"v8.0"},{"name":"v7.0","value":"v7.0"},{"name":"v6.0","value":"v6.0"},{"name":"v5.0","value":"v5.0"},{"name":"v4.0","value":"v4.0"},{"name":"v3.3","value":"v3.3"},{"name":"v3.2","value":"v3.2"},{"name":"v3.1","value":"v3.1"},{"name":"v3.0","value":"v3.0"}],"default":"","description":"The version of the Graph API to be used in the request","required":true},{"displayName":"Node","name":"node","type":"string","default":"","description":"The node on which to operate. A node is an individual object with a unique ID. For example, there are many User node objects, each with a unique ID representing a person on Facebook.","placeholder":"me","required":true},{"displayName":"Edge","name":"edge","type":"string","default":"","description":"Edge of the node on which to operate. Edges represent collections of objects which are attached to the node.","placeholder":"videos"},{"displayName":"Ignore SSL Issues","name":"allowUnauthorizedCerts","type":"boolean","default":false,"description":"Whether to connect even if SSL certificate validation is not possible"},{"displayName":"Send Binary Data","name":"sendBinaryData","type":"boolean","displayOptions":{"show":{"httpRequestMethod":["POST","PUT"]}},"default":false,"required":true,"description":"Whether binary data should be sent as body"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"","placeholder":"file:data","displayOptions":{"hide":{"sendBinaryData":[false]},"show":{"httpRequestMethod":["POST","PUT"]}},"description":"Name of the binary property which contains the data for the file to be uploaded. For Form-Data Multipart, they can be provided in the format: <code>\"sendKey1:binaryProperty1,sendKey2:binaryProperty2</code>"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Fields","name":"fields","placeholder":"Add Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"/httpRequestMethod":["GET"]}},"description":"The list of fields to request in the GET request","default":{},"options":[{"name":"field","displayName":"Field","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the field"}]}]},{"displayName":"Query Parameters","name":"queryParameters","placeholder":"Add Parameter","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The query parameters to send","default":{},"options":[{"name":"parameter","displayName":"Parameter","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the parameter"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the parameter"}]}]},{"displayName":"Query Parameters JSON","name":"queryParametersJson","type":"json","default":"{}","placeholder":"{\"field_name\": \"field_value\"}","description":"The query parameters to send, defined as a JSON object"}]}]


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

  # Facebook Trigger node

  [Facebook](https://www.facebook.com/){:target=_blank .external-link} is a social networking site to connect and share with family and friends online.

  Use the Facebook Trigger node to trigger a workflow when events occur in Facebook.

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

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

  ## Objects

  - [**Ad Account**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/ad-account.md): Get updates for certain ads changes.
  - [**Application**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/application.md): Get updates sent to the application.
  - [**Certificate Transparency**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/certificate-transparency.md): Get updates when new security certificates are generated for your subscribed domains, including new certificates and potential phishing attempts.
  - Activity and events in a [**Group**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/group.md)
  - [**Instagram**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/instagram.md): Get updates when someone comments on the Media objects of your app users; @mentions your app users; or when Stories of your app users expire.
  - [**Link**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/link.md): Get updates about the links for rich previews by an external provider
  - [**Page**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/page.md) updates
  - [**Permissions**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/permissions.md): Updates when granting or revoking permissions
  - [**User**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/user.md) profile updates
  - [**WhatsApp Business Account**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/whatsapp.md)
      
      /// note | Use WhatsApp Trigger
      n8n recommends using the [WhatsApp Trigger node](/integrations/builtin/trigger-nodes/n8n-nodes-base.whatsapptrigger.md) with the [WhatsApp credentials](/integrations/builtin/credentials/whatsapp.md) instead of the Facebook Trigger node for these events. The WhatsApp Trigger node has more events to listen to.
      ///

  - [**Workplace Security**](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/workplace-security.md)

  For each **Object**, use the **Field Names or IDs** dropdown to select more details on what data to receive. Refer to the linked pages for more details.

  ## Related resources

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

  Refer to Meta's [Graph API documentation](https://developers.facebook.com/docs/graph-api/webhooks/reference){:target=_blank .external-link} for details about their API.

properties_schema:
  [{"displayName":"APP ID","name":"appId","type":"string","required":true,"default":"","description":"Facebook APP ID"},{"displayName":"Object","name":"object","type":"options","options":[{"name":"Ad Account","value":"adAccount","description":"Get updates about Ad Account"},{"name":"Application","value":"application","description":"Get updates about the app"},{"name":"Certificate Transparency","value":"certificateTransparency","description":"Get updates about Certificate Transparency"},{"name":"Group","value":"group","description":"Get updates about activity in groups and events in groups for Workplace"},{"name":"Instagram","value":"instagram","description":"Get updates about comments on your media"},{"name":"Link","value":"link","description":"Get updates about links for rich previews by an external provider"},{"name":"Page","value":"page","description":"Page updates"},{"name":"Permissions","value":"permissions","description":"Updates regarding granting or revoking permissions"},{"name":"User","value":"user","description":"User profile updates"},{"name":"Whatsapp Business Account","value":"whatsappBusinessAccount","description":"Get updates about Whatsapp business account"},{"name":"Workplace Security","value":"workplaceSecurity","description":"Get updates about Workplace Security"}],"required":true,"default":"user","description":"The object to subscribe to"},{"displayName":"Field Names or IDs","name":"fields","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getObjectFields","loadOptionsDependsOn":["object"]},"default":[],"description":"The set of fields in this object that are subscribed to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add option","options":[{"displayName":"Include Values","name":"includeValues","type":"boolean","default":true,"description":"Whether change notifications should include the new values"}]}]


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

  # Facebook Lead Ads Trigger node

  Use the Facebook Lead Ads Trigger node to respond to events in [Facebook Lead Ads](https://www.facebook.com/business/ads/lead-ads/){:target=_blank .external-link} and integrate Facebook Lead Ads with other applications. n8n has built-in support for responding to new leads.

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

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

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

  ## Events

  * New lead

  ## Related resources

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

  Refer to [Facebook Lead Ads' documentation](https://developers.facebook.com/docs/marketing-api/guides/lead-ads/){:target=_blank .external-link} for details about their API.

  ## Common issues

  Here are some common errors and issues with the Facebook Lead Ads Trigger node and steps to resolve or troubleshoot them.

  ### Workflow only works in testing or production

  Facebook Lead Ads only allows you to register a single webhook per app. This means that every time you switch from using the testing URL to the production URL (and vice versa), Facebook Lead Ads overwrites the registered webhook URL. 

  You may have trouble with this if you try to test a workflow that's also active in production. Facebook Lead Ads will only send events to one of the two webhook URLs, so the other will never receive event notifications.

  To work around this, you can disable your workflow when testing:

  /// warning | Halts production traffic
  This workaround temporarily disables your production workflow for testing. Your workflow will no longer receive production traffic while it's deactivated.
  ///

  1. Go to your workflow page.
  2. Toggle the **Active** switch in the top panel to disable the workflow temporarily.
  3. Test your workflow using the test webhook URL.
  4. When you finish testing, toggle the **Inactive** toggle to enable the workflow again. The production webhook URL should resume working.

properties_schema:
  [{"displayName":"Due to Facebook API limitations, you can use just one Facebook Lead Ads trigger for each Facebook App","name":"facebookLeadAdsNotice","type":"notice","default":""},{"displayName":"Event","name":"event","type":"options","required":true,"default":"newLead","options":[{"name":"New Lead","value":"newLead"}]},{"displayName":"Page","name":"page","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"description":"The page linked to the form for retrieving new leads","modes":[{"displayName":"From List","name":"list","type":"list","typeOptions":{"searchListMethod":"pageList"}},{"displayName":"By ID","name":"id","type":"string","placeholder":"121637951029080"}]},{"displayName":"Form","name":"form","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"description":"The form to monitor for fetching lead details upon submission","modes":[{"displayName":"From List","name":"list","type":"list","typeOptions":{"searchListMethod":"formList"}},{"displayName":"By ID","name":"id","type":"string","placeholder":"121637951029080"}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Simplify Output","name":"simplifyOutput","type":"boolean","default":true,"description":"Whether to return a simplified version of the webhook event instead of all fields"}]}]


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

  # Figma Trigger (Beta) node

  [Figma](https://www.figma.com/){:target=_blank .external-link} is a prototyping tool which is primarily web-based, with more offline features enabled by desktop applications for macOS and Windows.

  /// warning | Supported Figma Plans
  Figma doesn't support webhooks on the free "Starter" plan. Your team needs to be on the "Professional" plan to use this node.
  ///

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

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

  ## Events

  - **File Commented**: Triggers when someone comments on a file.
  - **File Deleted**: Triggers when someone deletes an individual file, but not when someone deletes an entire folder with all files.
  - **File Updated**: Triggers when someone saves or deletes a file. A save occurs when someone closes a file within 30 seconds after making changes.
  - **File Version Updated**: Triggers when someone creates a named version in the version history of a file.
  - **Library Publish**: Triggers when someone publishes a library file.

properties_schema:
  [{"displayName":"Team ID","name":"teamId","type":"string","required":true,"default":"","description":"Trigger will monitor this Figma Team for changes. Team ID can be found in the URL of a Figma Team page when viewed in a web browser: figma.com/files/team/{TEAM-ID}/."},{"displayName":"Trigger On","name":"triggerOn","type":"options","options":[{"name":"File Commented","value":"fileComment","description":"Triggers when someone comments on a file"},{"name":"File Deleted","value":"fileDelete","description":"Triggers whenever a file has been deleted. Does not trigger on all files within a folder, if the folder is deleted."},{"name":"File Updated","value":"fileUpdate","description":"Triggers whenever a file saves or is deleted. This occurs whenever a file is closed or within 30 seconds after changes have been made."},{"name":"File Version Updated","value":"fileVersionUpdate","description":"Triggers whenever a named version is created in the version history of a file"},{"name":"Library Publish","value":"libraryPublish","description":"Triggers whenever a library file is published"}],"default":"","required":true}]


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

  # FileMaker node

  Use the FileMaker node to automate work in FileMaker, and integrate FileMaker with other applications. n8n has built-in support for a wide range of FileMaker features, including creating, finding, getting, editing, and duplicating files.

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

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

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

  ## Operations

  - Find Records
  - Get Records
  - Get Records by Id
  - Perform Script
  - Create Record
  - Edit Record
  - Duplicate Record
  - Delete Record

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Action","name":"action","type":"options","default":"record","options":[{"name":"Create Record","value":"create"},{"name":"Delete Record","value":"delete"},{"name":"Duplicate Record","value":"duplicate"},{"name":"Edit Record","value":"edit"},{"name":"Find Records","value":"find"},{"name":"Get Records","value":"records"},{"name":"Get Records By ID","value":"record"},{"name":"Perform Script","value":"performscript"}]},{"displayName":"Layout Name or ID","name":"layout","type":"options","typeOptions":{"loadOptionsMethod":"getLayouts"},"options":[],"default":"","required":true,"displayOptions":{},"placeholder":"Layout Name","description":"FileMaker Layout Name. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Record ID","name":"recid","type":"number","default":"","required":true,"displayOptions":{"show":{"action":["record","edit","delete","duplicate"]}},"placeholder":"Record ID","description":"Internal Record ID returned by get (recordid)"},{"displayName":"Offset","name":"offset","placeholder":"0","description":"The record number of the first record in the range of records","type":"number","default":1,"displayOptions":{"show":{"action":["find","records"]}}},{"displayName":"Limit","name":"limit","placeholder":"100","description":"Max number of results to return","type":"number","typeOptions":{"minValue":1},"default":100,"displayOptions":{"show":{"action":["find","records"]}}},{"displayName":"Get Portals","name":"getPortals","type":"boolean","default":false,"description":"Whether to get portal data as well","displayOptions":{"show":{"action":["record","records","find"]}}},{"displayName":"Portals Name or ID","name":"portals","type":"options","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add portal","loadOptionsMethod":"getPortals"},"options":[],"default":[],"displayOptions":{"show":{"action":["record","records","find"],"getPortals":[true]}},"placeholder":"Portals","description":"The portal result set to return. Use the portal object name or portal table name. If this parameter is omitted, the API will return all portal objects and records in the layout. For best performance, pass the portal object name or portal table name. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Response Layout Name or ID","name":"responseLayout","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":"getResponseLayouts"},"options":[],"default":"","displayOptions":{"show":{"action":["find"]}}},{"displayName":"Queries","name":"queries","placeholder":"Add query","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"action":["find"]}},"default":{},"options":[{"name":"query","displayName":"Query","values":[{"displayName":"Fields","name":"fields","placeholder":"Add field","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"options":[{"name":"field","displayName":"Field","values":[{"displayName":"Field Name or ID","name":"name","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getFields"},"options":[],"description":"Search Field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value to search"}]}],"description":"Field Name"},{"displayName":"Omit","name":"omit","type":"boolean","default":false}]}]},{"displayName":"Sort Data?","name":"setSort","type":"boolean","default":false,"description":"Whether to sort data","displayOptions":{"show":{"action":["find","record","records"]}}},{"displayName":"Sort","name":"sortParametersUi","placeholder":"Add Sort Rules","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"setSort":[true],"action":["find","records"]}},"description":"Sort rules","default":{},"options":[{"name":"rules","displayName":"Rules","values":[{"displayName":"Field Name or ID","name":"name","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getFields"},"options":[],"description":"Field Name. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Order","name":"value","type":"options","default":"ascend","options":[{"name":"Ascend","value":"ascend"},{"name":"Descend","value":"descend"}],"description":"Sort order"}]}]},{"displayName":"Before Find Script","name":"setScriptBefore","type":"boolean","default":false,"description":"Whether to define a script to be run before the action specified by the API call and after the subsequent sort","displayOptions":{"show":{"action":["find","record","records"]}}},{"displayName":"Script Name or ID","name":"scriptBefore","type":"options","typeOptions":{"loadOptionsMethod":"getScripts"},"options":[],"default":"","required":true,"displayOptions":{"show":{"action":["find","record","records"],"setScriptBefore":[true]}},"placeholder":"Script Name","description":"The name of the FileMaker script to be run after the action specified by the API call and after the subsequent sort. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Script Parameter","name":"scriptBeforeParam","type":"string","default":"","displayOptions":{"show":{"action":["find","record","records"],"setScriptBefore":[true]}},"placeholder":"Script Parameters","description":"A parameter for the FileMaker script"},{"displayName":"Before Sort Script","name":"setScriptSort","type":"boolean","default":false,"description":"Whether to define a script to be run after the action specified by the API call but before the subsequent sort","displayOptions":{"show":{"action":["find","record","records"]}}},{"displayName":"Script Name or ID","name":"scriptSort","type":"options","typeOptions":{"loadOptionsMethod":"getScripts"},"options":[],"default":"","required":true,"displayOptions":{"show":{"action":["find","record","records"],"setScriptSort":[true]}},"placeholder":"Script Name","description":"The name of the FileMaker script to be run after the action specified by the API call but before the subsequent sort. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Script Parameter","name":"scriptSortParam","type":"string","default":"","displayOptions":{"show":{"action":["find","record","records"],"setScriptSort":[true]}},"placeholder":"Script Parameters","description":"A parameter for the FileMaker script"},{"displayName":"After Sort Script","name":"setScriptAfter","type":"boolean","default":false,"description":"Whether to define a script to be run after the action specified by the API call but before the subsequent sort","displayOptions":{"show":{"action":["find","record","records"]}}},{"displayName":"Script Name or ID","name":"scriptAfter","type":"options","typeOptions":{"loadOptionsMethod":"getScripts"},"options":[],"default":"","required":true,"displayOptions":{"show":{"action":["find","record","records"],"setScriptAfter":[true]}},"placeholder":"Script Name","description":"The name of the FileMaker script to be run after the action specified by the API call and after the subsequent sort. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Script Parameter","name":"scriptAfterParam","type":"string","default":"","displayOptions":{"show":{"action":["find","record","records"],"setScriptAfter":[true]}},"placeholder":"Script Parameters","description":"A parameter for the FileMaker script"},{"displayName":"Mod ID","name":"modId","description":"The last modification ID. When you use modId, a record is edited only when the modId matches.","type":"number","default":"","displayOptions":{"show":{"action":["edit"]}}},{"displayName":"Fields","name":"fieldsParametersUi","placeholder":"Add field","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"action":["create","edit"]}},"description":"Fields to define","default":{},"options":[{"name":"fields","displayName":"Fields","values":[{"displayName":"Field Name or ID","name":"name","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getFields"},"options":[],"description":"Field Name. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Script Name or ID","name":"script","type":"options","typeOptions":{"loadOptionsMethod":"getScripts"},"options":[],"default":"","required":true,"displayOptions":{"show":{"action":["performscript"]}},"placeholder":"Script Name","description":"The name of the FileMaker script to be run. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Script Parameter","name":"scriptParam","type":"string","default":"","displayOptions":{"show":{"action":["performscript"]}},"placeholder":"Script Parameters","description":"A parameter for the FileMaker script"}]


node_type: filter
package_name: n8n-nodes-base
display_name: Filter
description: Filter out incoming items based on given conditions
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: Filter
  description: Documentation for the Filter node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  ---

  # Filter

  Filter items based on a condition. If the item meets the condition, the Filter node passes it on to the next node in the Filter node output. If the item doesn't meet the condition, the Filter node omits the item from its output.

  ## Node parameters

  Create filter comparison **Conditions** to perform your filter.

  - 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 items:

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

  You can't create a mix of AND and OR rules.

  ## Node options

  - **Ignore Case**: Whether to ignore letter case (turned on) or be case sensitive (turned off).
  - **Less Strict Type Validation**: Whether you want n8n to attempt to convert value types based on the operator you choose (turned on) or not (turned off). Turn this on when facing a "wrong type:" error in your node.

  ## Templates and examples

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

  --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 Conditions","name":"combineConditions","type":"options","options":[{"name":"AND","description":"Items are passed to the next node only if they meet all the conditions","value":"AND"},{"name":"OR","description":"Items are passed to the next node if they meet at least one condition","value":"OR"}],"default":"AND","description":"How to combine the conditions: AND requires all conditions to be true, OR requires at least one condition to be true"}]


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

  # Flow node

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

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

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

  ## Operations

  * Task
      * Create a new task
      * Update a task
      * Get a task
      * Get all the tasks

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Task","value":"task","description":"Tasks are units of work that can be private or assigned to a list. Through this endpoint, you can manipulate your tasks in Flow, including creating new ones."}],"default":"task"},{"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":"Update","value":"update","description":"Update a task","action":"Update a task"},{"name":"Get","value":"get","description":"Get a task","action":"Get a task"},{"name":"Get Many","value":"getAll","description":"Get many tasks","action":"Get many tasks"}],"default":"create"},{"displayName":"Workspace ID","name":"workspaceId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"description":"Create resources under the given workspace"},{"displayName":"Name","name":"name","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"description":"The title of the task"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"options":[{"displayName":"Owner ID","name":"ownerid","type":"string","default":"","description":"The ID of the account to whom this task will be assigned"},{"displayName":"List ID","name":"listID","type":"string","default":"","description":"Put the new task in a list (\"project\"). Omit this param to have the task be private."},{"displayName":"Starts On","name":"startsOn","type":"dateTime","default":"","description":"The date on which the task should start"},{"displayName":"Due On","name":"dueOn","type":"dateTime","default":"","description":"The date on which the task should be due"},{"displayName":"Mirror Parent Subscribers","name":"mirrorParentSubscribers","type":"boolean","default":false,"description":"Whether this task will be a subtask, and this is true, the parent tasks's subscribers will be mirrored to this one"},{"displayName":"Mirror Parent Tags","name":"mirrorParentTags","type":"boolean","default":false,"description":"Whether this task will be a subtask, and this is true, the parent tasks's tags will be mirrored to this one"},{"displayName":"Note Content","name":"noteContent","type":"string","default":"","description":"Provide the content for the task's note"},{"displayName":"Note Mime Type","name":"noteMimeType","type":"options","default":"text/plain","options":[{"name":"text/plain","value":"text/plain"},{"name":"text/x-markdown","value":"text/x-markdown"},{"name":"text/html","value":"text/html"}],"description":"Identify which markup language is used to format the given note"},{"displayName":"Parent ID","name":"parentId","type":"string","default":"","description":"If provided, this task will become a subtask of the given task"},{"displayName":"Position List","name":"positionList","type":"number","default":0,"description":"Determines the sort order when showing tasks in, or grouped by, a list"},{"displayName":"Position Upcoming","name":"positionUpcoming","type":"number","default":0,"description":"Determines the sort order when showing tasks grouped by their due_date"},{"displayName":"Position","name":"position","type":"number","default":0,"description":"Determines the sort order of tasks"},{"displayName":"Section ID","name":"sectionId","type":"string","default":"","description":"Specify which section under which to create this task"},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"A list of tag names to apply to the new task separated by a comma (,)"}]},{"displayName":"Workspace ID","name":"workspaceId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"description":"Create resources under the given workspace"},{"displayName":"Task ID","name":"taskId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Update Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"The title of the task"},{"displayName":"Completed","name":"completed","type":"boolean","default":false,"description":"Whether to complete the task"},{"displayName":"Owner ID","name":"ownerid","type":"string","default":"","description":"The ID of the account to whom this task will be assigned"},{"displayName":"List ID","name":"listID","type":"string","default":"","description":"Put the new task in a list (\"project\"). Omit this param to have the task be private."},{"displayName":"Starts On","name":"startsOn","type":"dateTime","default":"","description":"The date on which the task should start"},{"displayName":"Due On","name":"dueOn","type":"dateTime","default":"","description":"The date on which the task should be due"},{"displayName":"Mirror Parent Subscribers","name":"mirrorParentSubscribers","type":"boolean","default":false,"description":"Whether this task will be a subtask, and this is true, the parent tasks's subscribers will be mirrored to this one"},{"displayName":"Mirror Parent Tags","name":"mirrorParentTags","type":"boolean","default":false,"description":"Whether this task will be a subtask, and this is true, the parent tasks's tags will be mirrored to this one"},{"displayName":"Note Content","name":"noteContent","type":"string","default":"","description":"Provide the content for the task's note"},{"displayName":"Note Mime Type","name":"noteMimeType","type":"options","default":"text/plain","options":[{"name":"Text/plain","value":"text/plain"},{"name":"text/x-markdown","value":"text/x-markdown"},{"name":"Text/html","value":"text/html"}],"description":"Identify which markup language is used to format the given note"},{"displayName":"Parent ID","name":"parentId","type":"string","default":"","description":"If provided, this task will become a subtask of the given task"},{"displayName":"Position List","name":"positionList","type":"number","default":0,"description":"Determines the sort order when showing tasks in, or grouped by, a list"},{"displayName":"Position Upcoming","name":"positionUpcoming","type":"number","default":0,"description":"Determines the sort order when showing tasks grouped by their due_date"},{"displayName":"Position","name":"position","type":"number","default":0,"description":"Determines the sort order of tasks"},{"displayName":"Section ID","name":"sectionId","type":"string","default":"","description":"Specify which section under which to create this task"},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"A list of tag names to apply to the new task separated by a comma (,)"}]},{"displayName":"Task ID","name":"taskId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["task"],"operation":["get"]}}},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["get"]}},"options":[{"displayName":"Include","name":"include","type":"multiOptions","default":[],"options":[{"name":"Schedule","value":"schedule"},{"name":"Files","value":"files"},{"name":"File Associations","value":"file_associations"},{"name":"Parent","value":"parent"}]}]},{"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":50,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"options":[{"displayName":"Include","name":"include","type":"multiOptions","default":[],"options":[{"name":"Schedule","value":"schedule"},{"name":"Files","value":"files"},{"name":"File Associations","value":"file_associations"},{"name":"Parent","value":"parent"}]},{"displayName":"Order","name":"order","type":"options","default":"created_at","options":[{"name":"Account ID","value":"account_id"},{"name":"Completed At","value":"completed_at"},{"name":"Created At","value":"created_at"},{"name":"Due On","value":"due_on"},{"name":"List ID","value":"list_id"},{"name":"Name","value":"name"},{"name":"Owner ID","value":"owner_id"},{"name":"Position","value":"position"},{"name":"Section ID","value":"section_id"},{"name":"Starts On","value":"starts_on"},{"name":"Updated At","value":"updated_at"}]},{"displayName":"Workspace ID","name":"workspaceId","type":"string","default":"","description":"Create resources under the given workspace"},{"displayName":"Created Before","name":"createdBefore","type":"dateTime","default":"","description":"Select resources created before a certain time"},{"displayName":"Created After","name":"createdAfter","type":"dateTime","default":"","description":"Select resources created after a certain time"},{"displayName":"Update Before","name":"updateBefore","type":"dateTime","default":"","description":"Select resources updated before a certain time"},{"displayName":"Update After","name":"updateAfter","type":"dateTime","default":"","description":"Select resources updated after a certain time"},{"displayName":"Deleted","name":"deleted","type":"boolean","default":false,"description":"Whether to select deleted resources"},{"displayName":"Cleared","name":"cleared","type":"boolean","default":false,"description":"Whether to select cleared resources"}]}]

operations:
  [{"type":"resource","resource":"task","name":"Task"},{"type":"operation","operation":"create","name":"Create","action":"Create a task","resources":["task"]},{"type":"operation","operation":"update","name":"Update","action":"Update 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"]}]


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

  # Flow Trigger node

  [Flow](https://www.getflow.com/){:target=_blank .external-link} is modern task and project management software for teams. It brings together tasks, projects, timelines, and conversations, and integrates with a lot of tools.

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"default":"","options":[{"name":"Project","value":"list"},{"name":"Task","value":"task"}],"description":"Resource that triggers the webhook"},{"displayName":"Project ID","name":"listIds","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["list"]},"hide":{"resource":["task"]}},"description":"Lists IDs, perhaps known better as \"Projects\" separated by a comma (,)"},{"displayName":"Task ID","name":"taskIds","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"]},"hide":{"resource":["list"]}},"description":"Task IDs separated by a comma (,)"}]

operations:
  [{"type":"resource","resource":"list","name":"Project"},{"type":"resource","resource":"task","name":"Task"}]


node_type: formTrigger
package_name: n8n-nodes-base
display_name: n8n Form Trigger
description: Runs the flow when an n8n generated webform is submitted
category: trigger
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: n8n Form Trigger node documentation
  description: Learn how to use the n8n Form Trigger node in n8n. Follow technical documentation to integrate n8n Form Trigger node into your workflows.
  contentType: [integration, reference]
  priority: critical
  ---

  # n8n Form Trigger node

  Use the n8n Form trigger to start a workflow when a user submits a form, taking the input data from the form. The node generates the form web page for you to use.

  You can add more pages to continue the form with the [n8n Form](/integrations/builtin/core-nodes/n8n-nodes-base.form.md) node.

  ## Build and test workflows

  While building or testing a workflow, use the **Test URL**. Using a test URL ensures that you can view the incoming data in the editor UI, which is useful for debugging. 

  There are two ways to test:

  - Select **Test Step**. n8n opens the form. When you submit the form, n8n runs the node, but not the rest of the workflow.
  - Select **Test Workflow**. n8n opens the form. When you submit the form, n8n runs the workflow.

  ## Production workflows

  When your workflow is ready, switch to using the **Production URL**. You can then activate your workflow, and n8n runs it automatically when a user submits the form.

  When working with a production URL, ensure that you have saved and activated the workflow. Data flowing through the Form trigger isn't visible in the editor UI with the production URL.

  ## Set default selections with query parameters

  You can set the initial values for fields by using [query parameters](https://en.wikipedia.org/wiki/Query_string#Web_forms){:target=_blank .external-link} with the initial URL provided by the n8n Form Trigger. Every [page in the form](/integrations/builtin/core-nodes/n8n-nodes-base.form.md) receives the same query parameters sent to the n8n Form Trigger URL.

  /// note | Only for production
  Query parameters are only available when using the form in production mode. n8n won't populate field values from query parameters in testing mode.
  ///

  <!-- vale from-microsoft.Percentages = NO -->
  When using query parameters, [percent-encode](https://en.wikipedia.org/wiki/Percent-encoding){:target=_blank .external-link} any field names or values that use special characters. This ensures n8n uses the initial values for the given fields. You can use tools like [URL Encode/Decode](https://www.url-encode-decode.com/) to format your query parameters using percent-encoding.

  As an example, imagine you have a form with the following properties:

  * Production URL: `https://my-account.n8n.cloud/form/my-form`
  * Fields:
  	* `name`: `Jane Doe`
  	* `email`: `jane.doe@example.com`

  With query parameters and percent-encoding, you could use the following URL to set initial field values to the data above:

  ```
  https://my-account.n8n.cloud/form/my-form?email=jane.doe%40example.com&name=Jane%20Doe
  ```

  Here, percent-encoding replaces the at-symbol (`@`) with the string `%40` and the space character (` `) with the string `%20`. This will set the initial value for these fields no matter which page of the form they appear on.
  <!-- vale from-microsoft.Percentages = YES -->

  ## Node parameters

  These are the main node configuration fields:

  ### Authentication

  - **Basic Auth**
  - **None**

  #### Using basic auth

  To configure this credential, you'll need:

  - The **Username** you use to access the app or service your HTTP Request is targeting.
  - The **Password** that goes with that username.

  ### Form URLs

  The Form Trigger node has two URLs: **Test URL** and **Production URL**. n8n displays the URLs at the top of the node panel. Select **Test URL** or **Production URL** to toggle which URL n8n displays.

  ![Screenshot of the form URLs](/_images/integrations/builtin/core-nodes/form-trigger/form-urls.png)

  - **Test URL**: n8n registers a test webhook when you select **Test Step** or **Test Workflow**, if the workflow isn't active. When you call the URL, n8n displays the data in the workflow.
  - **Production URL**: n8n registers a production webhook when you activate the workflow. When using the production URL, n8n doesn't display the data in the workflow. You can still view workflow data for a production execution. Select the **Executions** tab in the workflow, then select the workflow execution you want to view.

  ### Form Path

  Set a custom slug for the form.

  ### Form Title

  Enter the title for your form. n8n displays the **Form Title** as the webpage title and main `h1` title on the form.

  ### Form Description

  Enter the description for your form. n8n displays the **Form Description** as a subtitle below the main `h1` title on the form. Use `\n` or `<br>` to add a line break. 

  ### Form Elements

  Create the question fields for your form. Select **Add Form Element** to add a new field.

  Every field has the following settings:

  - **Field Label**: Enter the label that appears above the input field. 
  - **Element Type**: Choose from **Custom HTML**, **Date**, **Dropdown List**, **Email**, **File**, **Hidden Field**, **Number**, **Password**, **Text**, or **Textarea**.
  	- Select **Custom HTML** to insert arbitrary HTML.
  		- You can include elements like links, images, video, and more. You can't include `<script>`, `<style>`, or `<input>` elements.
  		- By default, Custom HTML fields aren't included in the node output. To include the Custom HTML content in the output, fill out the associated **Element Name** field.
      - Select **Date** to include a date picker in the form. Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information on formatting dates.
  	- Select **Dropdown List** > **Add Field Option** to add multiple options. By default, the dropdown is single-choice. To make it multiple-choice, turn on **Multiple Choice**. 
  	- Select **Hidden Field** to include a form element without displaying it on the form. You can set a default value using the **Field Value** parameter or pass values for the field using [query parameters](#set-default-selections-with-query-parameters).
  - **Required Field**: Turn on to require users to complete this field on the form. 

  ### Respond When

  Choose when n8n sends a response to the form submission. You can respond when:

  - **Form Is Submitted**: Send a response to the user as soon as they submit the form.
  - **Workflow Finishes**: Use this if you want the workflow to complete its execution before you send a response to the user. If the workflow errors, it sends a response to the user telling them there was a problem submitting the form.

  ## Node options

  Select **Add Option** to view more configuration options: 

  - **Append n8n Attribution**: Turn off to hide the **Form automated with n8n** attribute at the bottom of the form.
  - **Form Response**: Choose how to respond when the user submits the form. 
      - **Respond With** > **Form Submitted Text**: Show a message to the user.
      - **Respond With** > **Redirect URL**: Send the user to a new page.
  - **Ignore Bots**: Turn on to ignore requests from bots like link previewers and web crawlers. 
  - **Use Workflow Timezone**: Turn on to use the timezone in the [Workflow settings](/workflows/settings.md) instead of UTC (default). This affects the value of the `submittedAt` timestamp in the node output. 

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Form Title","name":"formTitle","type":"string","default":"","placeholder":"e.g. Contact us","required":true,"description":"Shown at the top of the form"},{"displayName":"Form Description","name":"formDescription","type":"string","default":"","placeholder":"e.g. We'll get back to you soon","description":"Shown underneath the Form Title. Can be used to prompt the user on how to complete the form."},{"displayName":"Form Fields","name":"formFields","placeholder":"Add Form Field","type":"fixedCollection","default":{"values":[{"label":"","fieldType":"text"}]},"typeOptions":{"multipleValues":true,"sortable":true},"options":[{"displayName":"Values","name":"values","values":[{"displayName":"Field Label","name":"fieldLabel","type":"string","default":"","placeholder":"e.g. What is your name?","description":"Label appears above the input field","required":true},{"displayName":"Field Type","name":"fieldType","type":"options","default":"text","description":"The type of field to add to the form","options":[{"name":"Text","value":"text"},{"name":"Number","value":"number"},{"name":"Date","value":"date"},{"name":"Dropdown List","value":"dropdown"}],"required":true},{"displayName":"Field Options","name":"fieldOptions","placeholder":"Add Field Option","description":"List of options that can be selected from the dropdown","type":"fixedCollection","default":{"values":[{"option":""}]},"required":true,"displayOptions":{"show":{"fieldType":["dropdown"]}},"typeOptions":{"multipleValues":true,"sortable":true},"options":[{"displayName":"Values","name":"values","values":[{"displayName":"Option","name":"option","type":"string","default":""}]}]},{"displayName":"Multiple Choice","name":"multiselect","type":"boolean","default":false,"description":"Whether to allow the user to select multiple options from the dropdown list","displayOptions":{"show":{"fieldType":["dropdown"]}}},{"displayName":"Required Field","name":"requiredField","type":"boolean","default":false,"description":"Whether to require the user to enter a value for this field before submitting the form"}]}]},{"displayName":"Respond When","name":"responseMode","type":"options","options":[{"name":"Form Is Submitted","value":"onReceived","description":"As soon as this node receives the form submission"},{"name":"Workflow Finishes","value":"lastNode","description":"When the last node of the workflow is executed"}],"default":"onReceived","description":"When to respond to the form submission"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Form Submitted Text","name":"formSubmittedText","description":"The text displayed to users after they filled the form","type":"string","default":"Your response has been recorded"}]}]


