# nodes

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

  # MongoDB node

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

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

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

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

  ## Operations

  * Aggregate documents
  * Delete documents
  * Find documents
  * Find and replace documents
  * Find and update documents
  * Insert documents
  * Update documents

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Aggregate","value":"aggregate","description":"Aggregate documents","action":"Aggregate documents"},{"name":"Delete","value":"delete","description":"Delete documents","action":"Delete documents"},{"name":"Find","value":"find","description":"Find documents","action":"Find documents"},{"name":"Find And Replace","value":"findOneAndReplace","description":"Find and replace documents","action":"Find and replace documents"},{"name":"Find And Update","value":"findOneAndUpdate","description":"Find and update documents","action":"Find and update documents"},{"name":"Insert","value":"insert","description":"Insert documents","action":"Insert documents"},{"name":"Update","value":"update","description":"Update documents","action":"Update documents"}],"default":"find"},{"displayName":"Collection","name":"collection","type":"string","required":true,"default":"","description":"MongoDB Collection"},{"displayName":"Query","name":"query","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"operation":["aggregate"]}},"default":"","placeholder":"[{ \"$match\": { \"$gt\": \"1950-01-01\" }, ... }]","hint":"Learn more about aggregation pipeline <a href=\"https://docs.mongodb.com/manual/core/aggregation-pipeline/\">here</a>","required":true,"description":"MongoDB aggregation pipeline query in JSON format"},{"displayName":"Delete Query (JSON Format)","name":"query","type":"json","typeOptions":{"rows":5},"displayOptions":{"show":{"operation":["delete"]}},"default":"{}","placeholder":"{ \"birth\": { \"$gt\": \"1950-01-01\" } }","required":true,"description":"MongoDB Delete query"},{"displayName":"Options","name":"options","type":"collection","displayOptions":{"show":{"operation":["find"]}},"default":{},"placeholder":"Add options","description":"Add query options","options":[{"displayName":"Limit","name":"limit","type":"number","typeOptions":{"minValue":1},"default":0,"description":"Use limit to specify the maximum number of documents or 0 for unlimited documents"},{"displayName":"Skip","name":"skip","type":"number","default":0,"description":"The number of documents to skip in the results set"},{"displayName":"Sort (JSON Format)","name":"sort","type":"json","typeOptions":{"rows":2},"default":"{}","placeholder":"{ \"field\": -1 }","description":"A JSON that defines the sort order of the result set"}]},{"displayName":"Query (JSON Format)","name":"query","type":"json","typeOptions":{"rows":5},"displayOptions":{"show":{"operation":["find"]}},"default":"{}","placeholder":"{ \"birth\": { \"$gt\": \"1950-01-01\" } }","required":true,"description":"MongoDB Find query"},{"displayName":"Fields","name":"fields","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"","placeholder":"name,description","description":"Comma-separated list of the fields to be included into the new document"},{"displayName":"Update Key","name":"updateKey","type":"string","displayOptions":{"show":{"operation":["update","findOneAndReplace","findOneAndUpdate"]}},"default":"id","required":true,"description":"Name of the property which decides which rows in the database should be updated. Normally that would be \"id\"."},{"displayName":"Fields","name":"fields","type":"string","displayOptions":{"show":{"operation":["update","findOneAndReplace","findOneAndUpdate"]}},"default":"","placeholder":"name,description","description":"Comma-separated list of the fields to be included into the new document"},{"displayName":"Upsert","name":"upsert","type":"boolean","displayOptions":{"show":{"operation":["update","findOneAndReplace","findOneAndUpdate"]}},"default":false,"description":"Whether to perform an insert if no documents match the update key"},{"displayName":"Options","name":"options","type":"collection","displayOptions":{"show":{"operation":["update","insert","findOneAndReplace","findOneAndUpdate"]}},"placeholder":"Add Option","default":{},"options":[{"displayName":"Date Fields","name":"dateFields","type":"string","default":"","description":"Comma separeted list of fields that will be parse as Mongo Date type"},{"displayName":"Use Dot Notation","name":"useDotNotation","type":"boolean","default":false,"description":"Whether to use dot notation to access date fields"}]}]


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

  # Monica CRM node

  Use the Monica CRM node to automate work in Monica CRM, and integrate Monica CRM with other applications. n8n has built-in support for a wide range of Monica CRM features, including creating, updating, deleting, and getting activities, calls, contracts, messages, tasks, and notes. 

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

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

  ## Operations

  * Activity
      * Create an activity
      * Delete an activity
      * Retrieve an activity
      * Retrieve all activities
      * Update an activity
  * Call
      * Create a call
      * Delete a call
      * Retrieve a call
      * Retrieve all calls
      * Update a call
  * Contact
      * Create a contact
      * Delete a contact
      * Retrieve a contact
      * Retrieve all contacts
      * Update a contact
  * Contact Field
      * Create a contact field
      * Delete a contact field
      * Retrieve a contact field
      * Update a contact field
  * Contact Tag
      * Add
      * Remove
  * Conversation
      * Create a conversation
      * Delete a conversation
      * Retrieve a conversation
      * Update a conversation
  * Conversation Message
      * Add a message to a conversation
      * Update a message in a conversation
  * Journal Entry
      * Create a journal entry
      * Delete a journal entry
      * Retrieve a journal entry
      * Retrieve all journal entries
      * Update a journal entry
  * Note
      * Create a note
      * Delete a note
      * Retrieve a note
      * Retrieve all notes
      * Update a note
  * Reminder
      * Create a reminder
      * Delete a reminder
      * Retrieve a reminder
      * Retrieve all reminders
      * Update a reminder
  * Tag
      * Create a tag
      * Delete a tag
      * Retrieve a tag
      * Retrieve all tags
      * Update a tag
  * Task
      * Create a task
      * Delete a task
      * Retrieve a task
      * Retrieve all tasks
      * Update a task

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Activity","value":"activity"},{"name":"Call","value":"call"},{"name":"Contact","value":"contact"},{"name":"Contact Field","value":"contactField"},{"name":"Contact Tag","value":"contactTag"},{"name":"Conversation","value":"conversation"},{"name":"Conversation Message","value":"conversationMessage"},{"name":"Journal Entry","value":"journalEntry"},{"name":"Note","value":"note"},{"name":"Reminder","value":"reminder"},{"name":"Tag","value":"tag"},{"name":"Task","value":"task"}],"default":"contact"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["activity"]}},"options":[{"name":"Create","value":"create","description":"Create an activity","action":"Create an activity"},{"name":"Delete","value":"delete","description":"Delete an activity","action":"Delete an activity"},{"name":"Get","value":"get","description":"Retrieve an activity","action":"Get an activity"},{"name":"Get Many","value":"getAll","description":"Retrieve many activities","action":"Get many activities"},{"name":"Update","value":"update","description":"Update an activity","action":"Update an activity"}],"default":"create"},{"displayName":"Activity Type Name or ID","name":"activityTypeId","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":"getActivityTypes"},"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Contacts","name":"contacts","description":"Comma-separated list of IDs of the contacts to associate the activity with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Happened At","name":"happenedAt","description":"Date when the activity happened","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Summary","name":"summary","description":"Brief description of the activity - max 255 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"options":[{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the activity - max 100,000 characters"}]},{"displayName":"Activity ID","name":"activityId","description":"ID of the activity to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"operation":["delete"]}}},{"displayName":"Activity ID","name":"activityId","description":"ID of the activity to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"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":["activity"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Activity ID","name":"activityId","description":"ID of the activity to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["activity"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["update"]}},"options":[{"displayName":"Activity Type Name or ID","name":"activity_type_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>","default":"","typeOptions":{"loadOptionsMethod":"getActivityTypes"}},{"displayName":"Contacts","name":"contacts","description":"IDs of the contacts to associate the activity with","type":"string","default":""},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description to add more details on the activity - max 100,000 characters"},{"displayName":"Happened At","name":"happened_at","description":"Date when the activity happened","type":"dateTime","default":""},{"displayName":"Summary","name":"summary","description":"Brief description of the activity - max 255 characters","type":"string","default":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["call"]}},"options":[{"name":"Create","value":"create","description":"Create a call","action":"Create a call"},{"name":"Delete","value":"delete","description":"Delete a call","action":"Delete a call"},{"name":"Get","value":"get","description":"Retrieve a call","action":"Get a call"},{"name":"Get Many","value":"getAll","description":"Retrieve many calls","action":"Get many calls"},{"name":"Update","value":"update","description":"Update a call","action":"Update a call"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the call with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["call"],"operation":["create"]}}},{"displayName":"Called At","name":"calledAt","description":"Date when the call happened","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["call"],"operation":["create"]}}},{"displayName":"Description","name":"content","description":"Description of the call - max 100,000 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["call"],"operation":["create"]}}},{"displayName":"Call ID","name":"callId","description":"ID of the call to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["call"],"operation":["delete"]}}},{"displayName":"Call ID","name":"callId","description":"ID of the call to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["call"],"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":["call"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["call"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Call ID","name":"callId","description":"ID of the call to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["call"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["call"],"operation":["update"]}},"options":[{"displayName":"Called At","name":"calledAt","description":"Date when the call happened","type":"dateTime","default":""},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the call with","type":"string","default":""},{"displayName":"Description","name":"content","description":"Description of the call - max 100,000 characters","type":"string","default":""}]},{"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":"Delete","value":"delete","description":"Delete a contact","action":"Delete a contact"},{"name":"Get","value":"get","description":"Retrieve a contact","action":"Get a contact"},{"name":"Get Many","value":"getAll","description":"Retrieve many contacts","action":"Get many contacts"},{"name":"Update","value":"update","description":"Update a contact","action":"Update a contact"}],"default":"create"},{"displayName":"First Name","name":"firstName","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}}},{"displayName":"Gender Name or ID","name":"genderId","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":"getGenders"},"displayOptions":{"show":{"resource":["contact"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"options":[{"displayName":"Birthdate","name":"birthdate","type":"dateTime","default":""},{"displayName":"Deceased Date","name":"deceasedDate","type":"dateTime","default":""},{"displayName":"Is Deceased","name":"isDeceased","description":"Whether the contact has passed away","type":"boolean","default":false},{"displayName":"Last Name","name":"last_name","type":"string","default":""},{"displayName":"Nickname","name":"nickname","type":"string","default":""},{"displayName":"Type","name":"is_partial","type":"options","default":false,"options":[{"name":"Real","value":false,"description":"Contact with their own contact sheet"},{"name":"Partial","value":true,"description":"Contact without their own contact sheet"}]}]},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["delete"]}}},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"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":["contact"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Search Term","name":"query","type":"string","default":"","description":"Search term to filter results by"},{"displayName":"Sort","name":"sort","type":"options","options":[{"name":"Ascended Created At","value":"created_at"},{"name":"Descended Created At","value":"-created_at"},{"name":"Ascended Updated At","value":"updated_at"},{"name":"Descended Updated At","value":"-updated_at"}],"default":""}],"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}}},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"options":[{"displayName":"Birthdate","name":"birthdate","type":"dateTime","default":""},{"displayName":"Deceased Date","name":"deceased_date","type":"dateTime","default":""},{"displayName":"First Name","name":"first_name","type":"string","default":""},{"displayName":"Gender Name or ID","name":"gender_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>","default":"","typeOptions":{"loadOptionsMethod":"getGenders"}},{"displayName":"Is Deceased","name":"is_deceased","description":"Whether the contact has passed away","type":"boolean","default":false},{"displayName":"Last Name","name":"last_name","type":"string","default":""},{"displayName":"Nickname","name":"nickname","type":"string","default":""},{"displayName":"Type","name":"is_partial","type":"options","default":false,"options":[{"name":"Real","value":false,"description":"Contact with their own contact sheet"},{"name":"Partial","value":true,"description":"Contact without their own contact sheet"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contactField"]}},"options":[{"name":"Create","value":"create","description":"Create a contact field","action":"Create a contact field"},{"name":"Delete","value":"delete","description":"Delete a contact field","action":"Delete a contact field"},{"name":"Get","value":"get","description":"Retrieve a contact field","action":"Get a contact field"},{"name":"Update","value":"update","description":"Update a contact field","action":"Update a contact field"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the contact field with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["create"]}}},{"displayName":"Contact Field Type Name or ID","name":"contactFieldTypeId","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,"typeOptions":{"loadOptionsMethod":"getContactFieldTypes"},"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["create"]}}},{"displayName":"Content","name":"data","description":"Content of the contact field - max 255 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["create"]}}},{"displayName":"Contact Field ID","name":"contactFieldId","description":"ID of the contactField to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["delete"]}}},{"displayName":"Contact Field ID","name":"contactFieldId","description":"ID of the contact field to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["get"]}}},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact whose fields to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"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":["contactField"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["contactField"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the contact field with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["update"]}}},{"displayName":"Contact Field ID","name":"contactFieldId","description":"ID of the contact field to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["update"]}}},{"displayName":"Contact Field Type Name or ID","name":"contactFieldTypeId","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":"getContactFieldTypes"},"required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["update"]}}},{"displayName":"Content","name":"data","description":"Content of the contact field - max 255 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactField"],"operation":["update"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contactTag"]}},"options":[{"name":"Add","value":"add","action":"Add a tag to a contact"},{"name":"Remove","value":"remove","action":"Remove a tag from a contact"}],"default":"add"},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to add a tag to","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactTag"],"operation":["add"]}}},{"displayName":"Tag Names or IDs","name":"tagsToAdd","description":"Tags to add to the contact. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTagsToAdd"},"required":true,"default":[],"displayOptions":{"show":{"resource":["contactTag"],"operation":["add"]}}},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to remove the tag from","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contactTag"],"operation":["remove"]}}},{"displayName":"Tag Names or IDs","name":"tagsToRemove","description":"Tags to remove from the contact. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","type":"multiOptions","required":true,"typeOptions":{"loadOptionsMethod":"getTagsToRemove"},"default":[],"displayOptions":{"show":{"resource":["contactTag"],"operation":["remove"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["conversation"]}},"options":[{"name":"Create","value":"create","description":"Create a conversation","action":"Create a conversation"},{"name":"Delete","value":"delete","description":"Delete a conversation","action":"Delete a conversation"},{"name":"Get","value":"get","description":"Retrieve a conversation","action":"Get a conversation"},{"name":"Update","value":"update","description":"Update a conversation","action":"Update a conversation"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the conversation with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversation"],"operation":["create"]}}},{"displayName":"Contact Field Type Name or ID","name":"contactFieldTypeId","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":"getContactFieldTypes"},"displayOptions":{"show":{"resource":["conversation"],"operation":["create"]}}},{"displayName":"Happened At","name":"happenedAt","description":"Date when the conversation happened","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["conversation"],"operation":["create"]}}},{"displayName":"Conversation ID","name":"conversationId","description":"ID of the conversation to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversation"],"operation":["delete"]}}},{"displayName":"Conversation ID","name":"conversationId","description":"ID of the conversation to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversation"],"operation":["get"]}}},{"displayName":"Conversation ID","name":"conversationId","description":"ID of the conversation to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversation"],"operation":["update"]}}},{"displayName":"Contact Field Type Name or ID","name":"contactFieldTypeId","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":"getContactFieldTypes"},"displayOptions":{"show":{"resource":["conversation"],"operation":["update"]}}},{"displayName":"Happened At","name":"happenedAt","description":"Date when the conversation happened","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["conversation"],"operation":["update"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["conversationMessage"]}},"options":[{"name":"Add","value":"add","description":"Add a message to a conversation","action":"Add a message to a conversation"},{"name":"Update","value":"update","description":"Update a message in a conversation","action":"Update a message in a conversation"}],"default":"add"},{"displayName":"Conversation ID","name":"conversationId","description":"ID of the contact whose conversation","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversationMessage"],"operation":["add"]}}},{"displayName":"Content","name":"content","description":"Content of the message","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversationMessage"],"operation":["add"]}}},{"displayName":"Written At","name":"writtenAt","description":"Date when the message was written","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["conversationMessage"],"operation":["add"]}}},{"displayName":"Written By","name":"writtenByMe","description":"Author of the message","type":"options","required":true,"default":true,"options":[{"name":"User","value":true},{"name":"Contact","value":false}],"displayOptions":{"show":{"resource":["conversationMessage"],"operation":["add"]}}},{"displayName":"Message ID","name":"messageId","description":"ID of the message to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversationMessage"],"operation":["update"]}}},{"displayName":"Conversation ID","name":"conversationId","description":"ID of the conversation whose message to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["conversationMessage"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["conversationMessage"],"operation":["update"]}},"options":[{"displayName":"Contact ID","name":"contact_id","description":"ID of the contact to associate the conversationMessage with","type":"string","default":""},{"displayName":"Content","name":"content","description":"Content of the message","type":"string","default":""},{"displayName":"Written At","name":"written_at","description":"Date when the message was written","type":"dateTime","default":""},{"displayName":"Written By","name":"written_by_me","description":"Author of the message","type":"options","default":true,"options":[{"name":"User","value":true},{"name":"Contact","value":false}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["journalEntry"]}},"options":[{"name":"Create","value":"create","description":"Create a journal entry","action":"Create a journal entry"},{"name":"Delete","value":"delete","description":"Delete a journal entry","action":"Delete a journal entry"},{"name":"Get","value":"get","description":"Retrieve a journal entry","action":"Get a journal entry"},{"name":"Get Many","value":"getAll","description":"Retrieve many journal entries","action":"Get many journal entries"},{"name":"Update","value":"update","description":"Update a journal entry","action":"Update a journal entry"}],"default":"create"},{"displayName":"Title","name":"title","description":"Title of the journal entry - max 250 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["journalEntry"],"operation":["create"]}}},{"displayName":"Content","name":"post","description":"Content of the journal entry - max 100,000 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["journalEntry"],"operation":["create"]}}},{"displayName":"Journal Entry ID","name":"journalId","description":"ID of the journal entry to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["journalEntry"],"operation":["delete"]}}},{"displayName":"Journal Entry ID","name":"journalId","description":"ID of the journal entry to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["journalEntry"],"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":["journalEntry"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["journalEntry"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Journal Entry ID","name":"journalId","description":"ID of the journal entry to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["journalEntry"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["journalEntry"],"operation":["update"]}},"options":[{"displayName":"Content","name":"post","description":"Content of the journal entry - max 100,000 characters","type":"string","default":""},{"displayName":"Title","name":"title","description":"Title of the journal entry - max 250 characters","type":"string","default":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["note"]}},"options":[{"name":"Create","value":"create","description":"Create a note","action":"Create a note"},{"name":"Delete","value":"delete","description":"Delete a note","action":"Delete a note"},{"name":"Get","value":"get","description":"Retrieve a note","action":"Get a note"},{"name":"Get Many","value":"getAll","description":"Retrieve many notes","action":"Get many notes"},{"name":"Update","value":"update","description":"Update a note","action":"Update a note"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the note with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["note"],"operation":["create"]}}},{"displayName":"Body","name":"body","description":"Body of the note - max 100,000 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["note"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["note"],"operation":["create"]}},"options":[{"displayName":"Is Favorited","name":"isFavorited","description":"Whether the note has been favorited","type":"boolean","default":false}]},{"displayName":"Note ID","name":"noteId","description":"ID of the note to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["note"],"operation":["delete"]}}},{"displayName":"Note ID","name":"noteId","description":"ID of the note to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["note"],"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":["note"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["note"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Note ID","name":"noteId","description":"ID of the note to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["note"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["note"],"operation":["update"]}},"options":[{"displayName":"Body","name":"body","description":"Body of the note - max 100,000 characters","type":"string","default":""},{"displayName":"Contact ID","name":"contact_id","description":"ID of the contact to associate the note with","type":"string","default":""},{"displayName":"Is Favorited","name":"is_favorited","description":"Whether the note has been favorited","type":"boolean","default":false}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["reminder"]}},"options":[{"name":"Create","value":"create","description":"Create a reminder","action":"Create a reminder"},{"name":"Delete","value":"delete","description":"Delete a reminder","action":"Delete a reminder"},{"name":"Get","value":"get","description":"Retrieve a reminder","action":"Get a reminder"},{"name":"Get Many","value":"getAll","description":"Retrieve many reminders","action":"Get many reminders"},{"name":"Update","value":"update","description":"Update a reminder","action":"Update a reminder"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","type":"string","default":"","description":"ID of the contact to associate the reminder with","displayOptions":{"show":{"resource":["reminder"],"operation":["create"]}}},{"displayName":"Frequency Type","name":"frequencyType","description":"Type of frequency of the reminder","type":"options","required":true,"default":"one_time","options":[{"name":"Once","value":"one_time"},{"name":"Weekly","value":"week"},{"name":"Monthly","value":"month"},{"name":"Yearly","value":"year"}],"displayOptions":{"show":{"resource":["reminder"],"operation":["create"]}}},{"displayName":"Recurring Interval","name":"frequencyNumber","type":"number","default":0,"description":"Interval for the reminder","displayOptions":{"show":{"resource":["reminder"],"operation":["create"],"frequencyType":["week","month","year"]}}},{"displayName":"Initial Date","name":"initialDate","description":"Date of the reminder","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["reminder"],"operation":["create"]}}},{"displayName":"Title","name":"title","description":"Title of the reminder - max 100,000 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["reminder"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["reminder"],"operation":["create"]}},"options":[{"displayName":"Description","name":"description","type":"string","default":"","description":"Description about the reminder - Max 100,000 characters"}]},{"displayName":"Reminder ID","name":"reminderId","description":"ID of the reminder to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["reminder"],"operation":["delete"]}}},{"displayName":"Reminder ID","name":"reminderId","description":"ID of the reminder to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["reminder"],"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":["reminder"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["reminder"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Reminder ID","name":"reminderId","description":"ID of the reminder to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["reminder"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["reminder"],"operation":["update"]}},"options":[{"displayName":"Contact ID","name":"contact_id","type":"string","default":"","description":"ID of the contact to associate the reminder with"},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description about the reminder - Max 100,000 characters"},{"displayName":"Frequency Type","name":"frequency_type","description":"Frequency of the reminder","type":"options","default":"one_time","options":[{"name":"One Time","value":"one_time"},{"name":"Week","value":"week"},{"name":"Month","value":"month"},{"name":"Year","value":"year"}]},{"displayName":"Initial Date","name":"initial_data","description":"Date of the reminder","type":"dateTime","default":""},{"displayName":"Recurring Interval","name":"frequency_number","type":"number","default":0,"description":"Interval for the reminder","displayOptions":{"show":{"frequency_type":["week","month","year"]}}},{"displayName":"Title","name":"title","description":"Title of the reminder - max 100,000 characters","type":"string","default":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["tag"]}},"options":[{"name":"Create","value":"create","description":"Create a tag","action":"Create a tag"},{"name":"Delete","value":"delete","description":"Delete a tag","action":"Delete a tag"},{"name":"Get","value":"get","description":"Retrieve a tag","action":"Get a tag"},{"name":"Get Many","value":"getAll","description":"Retrieve many tags","action":"Get many tags"},{"name":"Update","value":"update","description":"Update a tag","action":"Update a tag"}],"default":"create"},{"displayName":"Name","name":"name","description":"Name of the tag - max 250 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["tag"],"operation":["create"]}}},{"displayName":"Tag ID","name":"tagId","description":"ID of the tag to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["tag"],"operation":["delete"]}}},{"displayName":"Tag ID","name":"tagId","description":"ID of the tag to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["tag"],"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":["tag"],"operation":["getAll"]}}},{"displayName":"Limit","name":"limit","type":"number","default":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["tag"],"operation":["getAll"],"returnAll":[false]}}},{"displayName":"Tag ID","name":"tagId","description":"ID of the tag to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["tag"],"operation":["update"]}}},{"displayName":"Name","name":"name","description":"Name of the tag - max 250 characters","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["tag"],"operation":["update"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["task"]}},"options":[{"name":"Create","value":"create","description":"Create a task","action":"Create a task"},{"name":"Delete","value":"delete","description":"Delete a task","action":"Delete a task"},{"name":"Get","value":"get","description":"Retrieve a task","action":"Get a task"},{"name":"Get Many","value":"getAll","description":"Retrieve many tasks","action":"Get many tasks"},{"name":"Update","value":"update","description":"Update a task","action":"Update a task"}],"default":"create"},{"displayName":"Contact ID","name":"contactId","description":"ID of the contact to associate the task with","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["create"]}}},{"displayName":"Title","name":"title","description":"Title of the task entry - max 250 characters","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":"Description","name":"description","type":"string","default":"","description":"Description of the task - max 100,000 characters"}]},{"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":50,"description":"Max number of results to return","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["task"],"operation":["getAll"],"returnAll":[false]}}},{"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":"Contact ID","name":"contactId","description":"ID of the contact to associate the task with","type":"string","default":""},{"displayName":"Completed","name":"completed","description":"Whether the task has been completed","type":"boolean","default":false},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the task - max 100,000 characters"},{"displayName":"Title","name":"title","description":"Title of the task entry - max 250 characters","type":"string","default":""}]}]

operations:
  [{"type":"resource","resource":"activity","name":"Activity"},{"type":"resource","resource":"call","name":"Call"},{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"contactField","name":"Contact Field"},{"type":"resource","resource":"contactTag","name":"Contact Tag"},{"type":"resource","resource":"conversation","name":"Conversation"},{"type":"resource","resource":"conversationMessage","name":"Conversation Message"},{"type":"resource","resource":"journalEntry","name":"Journal Entry"},{"type":"resource","resource":"note","name":"Note"},{"type":"resource","resource":"reminder","name":"Reminder"},{"type":"resource","resource":"tag","name":"Tag"},{"type":"resource","resource":"task","name":"Task"},{"type":"operation","operation":"create","name":"Create","action":"Create an activity","resources":["activity"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an activity","resources":["activity"]},{"type":"operation","operation":"get","name":"Get","action":"Get an activity","resources":["activity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many activities","resources":["activity"]},{"type":"operation","operation":"update","name":"Update","action":"Update an activity","resources":["activity"]},{"type":"operation","operation":"create","name":"Create","action":"Create a call","resources":["call"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a call","resources":["call"]},{"type":"operation","operation":"get","name":"Get","action":"Get a call","resources":["call"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many calls","resources":["call"]},{"type":"operation","operation":"update","name":"Update","action":"Update a call","resources":["call"]},{"type":"operation","operation":"create","name":"Create","action":"Create a contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact","resources":["contact"]},{"type":"operation","operation":"create","name":"Create","action":"Create a contact field","resources":["contactField"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact field","resources":["contactField"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact field","resources":["contactField"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact field","resources":["contactField"]},{"type":"operation","operation":"add","name":"Add","action":"Add a tag to a contact","resources":["contactTag"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a tag from a contact","resources":["contactTag"]},{"type":"operation","operation":"create","name":"Create","action":"Create a conversation","resources":["conversation"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a conversation","resources":["conversation"]},{"type":"operation","operation":"get","name":"Get","action":"Get a conversation","resources":["conversation"]},{"type":"operation","operation":"update","name":"Update","action":"Update a conversation","resources":["conversation"]},{"type":"operation","operation":"add","name":"Add","action":"Add a message to a conversation","resources":["conversationMessage"]},{"type":"operation","operation":"update","name":"Update","action":"Update a message in a conversation","resources":["conversationMessage"]},{"type":"operation","operation":"create","name":"Create","action":"Create a journal entry","resources":["journalEntry"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a journal entry","resources":["journalEntry"]},{"type":"operation","operation":"get","name":"Get","action":"Get a journal entry","resources":["journalEntry"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many journal entries","resources":["journalEntry"]},{"type":"operation","operation":"update","name":"Update","action":"Update a journal entry","resources":["journalEntry"]},{"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":"get","name":"Get","action":"Get a note","resources":["note"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many notes","resources":["note"]},{"type":"operation","operation":"update","name":"Update","action":"Update a note","resources":["note"]},{"type":"operation","operation":"create","name":"Create","action":"Create a reminder","resources":["reminder"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a reminder","resources":["reminder"]},{"type":"operation","operation":"get","name":"Get","action":"Get a reminder","resources":["reminder"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many reminders","resources":["reminder"]},{"type":"operation","operation":"update","name":"Update","action":"Update a reminder","resources":["reminder"]},{"type":"operation","operation":"create","name":"Create","action":"Create a tag","resources":["tag"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a tag","resources":["tag"]},{"type":"operation","operation":"get","name":"Get","action":"Get a tag","resources":["tag"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many tags","resources":["tag"]},{"type":"operation","operation":"update","name":"Update","action":"Update a tag","resources":["tag"]},{"type":"operation","operation":"create","name":"Create","action":"Create a task","resources":["task"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a task","resources":["task"]},{"type":"operation","operation":"get","name":"Get","action":"Get a task","resources":["task"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many tasks","resources":["task"]},{"type":"operation","operation":"update","name":"Update","action":"Update a task","resources":["task"]}]


node_type: moveBinaryData
package_name: n8n-nodes-base
display_name: Convert to/from binary data
description: Move data between binary and JSON properties
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Mode","name":"mode","type":"options","options":[{"name":"Binary to JSON","value":"binaryToJson","description":"Move data from Binary to JSON"},{"name":"JSON to Binary","value":"jsonToBinary","description":"Move data from JSON to Binary"}],"default":"binaryToJson","description":"From and to where data should be moved"},{"displayName":"Set All Data","name":"setAllData","type":"boolean","displayOptions":{"show":{"mode":["binaryToJson"]}},"default":true,"description":"Whether all JSON data should be replaced with the data retrieved from binary key. Else the data will be written to a single key."},{"displayName":"Source Key","name":"sourceKey","type":"string","displayOptions":{"show":{"mode":["binaryToJson"]}},"default":"data","required":true,"placeholder":"data","description":"The name of the binary key to get data from. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.currentKey\"."},{"displayName":"Destination Key","name":"destinationKey","type":"string","displayOptions":{"show":{"mode":["binaryToJson"],"setAllData":[false]}},"default":"data","required":true,"placeholder":"","description":"The name the JSON key to copy data to. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.newKey\"."},{"displayName":"Convert All Data","name":"convertAllData","type":"boolean","displayOptions":{"show":{"mode":["jsonToBinary"]}},"default":true,"description":"Whether all JSON data should be converted to binary. Else only the data of one key will be converted."},{"displayName":"Source Key","name":"sourceKey","type":"string","displayOptions":{"show":{"convertAllData":[false],"mode":["jsonToBinary"]}},"default":"data","required":true,"placeholder":"data","description":"The name of the JSON key to get data from. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.currentKey\"."},{"displayName":"Destination Key","name":"destinationKey","type":"string","displayOptions":{"show":{"mode":["jsonToBinary"]}},"default":"data","required":true,"placeholder":"data","description":"The name the binary key to copy data to. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.newKey\"."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Data Is Base64","name":"dataIsBase64","type":"boolean","displayOptions":{"hide":{"useRawData":[true]},"show":{"/mode":["jsonToBinary"],"/convertAllData":[false]}},"default":false,"description":"Whether to keep the binary data as base64 string"},{"displayName":"Encoding","name":"encoding","type":"options","options":[{"name":"armscii8","value":"armscii8"},{"name":"ascii","value":"ascii"},{"name":"base64","value":"base64"},{"name":"big5hkscs","value":"big5hkscs"},{"name":"binary","value":"binary"},{"name":"cesu8","value":"cesu8"},{"name":"cp1046","value":"cp1046"},{"name":"cp1124","value":"cp1124"},{"name":"cp1125","value":"cp1125"},{"name":"cp1129","value":"cp1129"},{"name":"cp1133","value":"cp1133"},{"name":"cp1161","value":"cp1161"},{"name":"cp1162","value":"cp1162"},{"name":"cp1163","value":"cp1163"},{"name":"cp437","value":"cp437"},{"name":"cp720","value":"cp720"},{"name":"cp737","value":"cp737"},{"name":"cp775","value":"cp775"},{"name":"cp808","value":"cp808"},{"name":"cp850","value":"cp850"},{"name":"cp852","value":"cp852"},{"name":"cp855","value":"cp855"},{"name":"cp856","value":"cp856"},{"name":"cp857","value":"cp857"},{"name":"cp858","value":"cp858"},{"name":"cp860","value":"cp860"},{"name":"cp861","value":"cp861"},{"name":"cp862","value":"cp862"},{"name":"cp863","value":"cp863"},{"name":"cp864","value":"cp864"},{"name":"cp865","value":"cp865"},{"name":"cp866","value":"cp866"},{"name":"cp869","value":"cp869"},{"name":"cp922","value":"cp922"},{"name":"cp936","value":"cp936"},{"name":"cp949","value":"cp949"},{"name":"cp950","value":"cp950"},{"name":"eucjp","value":"eucjp"},{"name":"gb18030","value":"gb18030"},{"name":"gbk","value":"gbk"},{"name":"georgianacademy","value":"georgianacademy"},{"name":"georgianps","value":"georgianps"},{"name":"hex","value":"hex"},{"name":"hproman8","value":"hproman8"},{"name":"iso646cn","value":"iso646cn"},{"name":"iso646jp","value":"iso646jp"},{"name":"iso88591","value":"iso88591"},{"name":"iso885910","value":"iso885910"},{"name":"iso885911","value":"iso885911"},{"name":"iso885913","value":"iso885913"},{"name":"iso885914","value":"iso885914"},{"name":"iso885915","value":"iso885915"},{"name":"iso885916","value":"iso885916"},{"name":"iso88592","value":"iso88592"},{"name":"iso88593","value":"iso88593"},{"name":"iso88594","value":"iso88594"},{"name":"iso88595","value":"iso88595"},{"name":"iso88596","value":"iso88596"},{"name":"iso88597","value":"iso88597"},{"name":"iso88598","value":"iso88598"},{"name":"iso88599","value":"iso88599"},{"name":"koi8r","value":"koi8r"},{"name":"koi8ru","value":"koi8ru"},{"name":"koi8t","value":"koi8t"},{"name":"koi8u","value":"koi8u"},{"name":"maccenteuro","value":"maccenteuro"},{"name":"maccroatian","value":"maccroatian"},{"name":"maccyrillic","value":"maccyrillic"},{"name":"macgreek","value":"macgreek"},{"name":"maciceland","value":"maciceland"},{"name":"macintosh","value":"macintosh"},{"name":"macroman","value":"macroman"},{"name":"macromania","value":"macromania"},{"name":"macthai","value":"macthai"},{"name":"macturkish","value":"macturkish"},{"name":"macukraine","value":"macukraine"},{"name":"mik","value":"mik"},{"name":"pt154","value":"pt154"},{"name":"rk1048","value":"rk1048"},{"name":"shiftjis","value":"shiftjis"},{"name":"tcvn","value":"tcvn"},{"name":"tis620","value":"tis620"},{"name":"ucs2","value":"ucs2"},{"name":"utf16","value":"utf16"},{"name":"utf16be","value":"utf16be"},{"name":"utf32","value":"utf32"},{"name":"utf32be","value":"utf32be"},{"name":"utf32le","value":"utf32le"},{"name":"utf7","value":"utf7"},{"name":"utf7imap","value":"utf7imap"},{"name":"utf8","value":"utf8"},{"name":"viscii","value":"viscii"},{"name":"windows1250","value":"windows1250"},{"name":"windows1251","value":"windows1251"},{"name":"windows1252","value":"windows1252"},{"name":"windows1253","value":"windows1253"},{"name":"windows1254","value":"windows1254"},{"name":"windows1255","value":"windows1255"},{"name":"windows1256","value":"windows1256"},{"name":"windows1257","value":"windows1257"},{"name":"windows1258","value":"windows1258"},{"name":"windows874","value":"windows874"}],"displayOptions":{"show":{"/mode":["binaryToJson","jsonToBinary"]}},"default":"utf8","description":"Set the encoding of the data stream"},{"displayName":"Strip BOM","name":"stripBOM","displayOptions":{"show":{"/mode":["binaryToJson"],"encoding":["utf8","cesu8","ucs2"]}},"type":"boolean","default":true},{"displayName":"Add BOM","name":"addBOM","displayOptions":{"show":{"/mode":["jsonToBinary"],"encoding":["utf8","cesu8","ucs2"]}},"type":"boolean","default":false},{"displayName":"File Name","name":"fileName","type":"string","displayOptions":{"show":{"/mode":["jsonToBinary"]}},"default":"","placeholder":"example.json","description":"The file name to set"},{"displayName":"JSON Parse","name":"jsonParse","type":"boolean","displayOptions":{"hide":{"keepAsBase64":[true]},"show":{"/mode":["binaryToJson"],"/setAllData":[false]}},"default":false,"description":"Whether to run JSON parse on the data to get proper object data"},{"displayName":"Keep Source","name":"keepSource","type":"boolean","default":false,"description":"Whether the source key should be kept. By default it will be deleted."},{"displayName":"Keep As Base64","name":"keepAsBase64","type":"boolean","displayOptions":{"hide":{"jsonParse":[true]},"show":{"/mode":["binaryToJson"],"/setAllData":[false]}},"default":false,"description":"Whether to keep the binary data as base64 string"},{"displayName":"MIME Type","name":"mimeType","type":"string","displayOptions":{"show":{"/mode":["jsonToBinary"]}},"default":"application/json","placeholder":"application/json","description":"The mime-type to set. By default will the mime-type for JSON be set."},{"displayName":"Use Raw Data","name":"useRawData","type":"boolean","displayOptions":{"hide":{"dataIsBase64":[true]},"show":{"/mode":["jsonToBinary"]}},"default":false,"description":"Whether to use data as is and do not JSON.stringify it"}]}]


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

  # MQTT node

  Use the MQTT node to automate work in MQTT, and integrate MQTT with other applications. n8n supports transporting messages with MQTT.

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

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

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

  ## Operations

  Use the MQTT node to send a message. You can set the message topic, and choose whether to send the node input data as part of the message.

  ## Templates and examples

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

  ## Related resources

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

  Refer to [MQTT's documentation](https://mqtt.org/getting-started/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [{"displayName":"Topic","name":"topic","type":"string","required":true,"default":"","description":"The topic to publish to"},{"displayName":"Send Input Data","name":"sendInputData","type":"boolean","default":true,"description":"Whether to send the the data the node receives as JSON"},{"displayName":"Message","name":"message","type":"string","required":true,"displayOptions":{"show":{"sendInputData":[false]}},"default":"","description":"The message to publish"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"QoS","name":"qos","type":"options","options":[{"name":"Received at Most Once","value":0},{"name":"Received at Least Once","value":1},{"name":"Exactly Once","value":2}],"default":0,"description":"QoS subscription level"},{"displayName":"Retain","name":"retain","type":"boolean","default":false,"description":"Normally if a publisher publishes a message to a topic, and no one is subscribed to that topic the message is simply discarded by the broker. However the publisher can tell the broker to keep the last message on that topic by setting the retain flag to true."}]}]


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

  # MQTT Trigger node

  [MQTT](https://mqtt.org){:target=_blank .external-link} is an open OASIS and ISO standard lightweight, publish-subscribe network protocol that transports messages between devices.

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

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

properties_schema:
  [{"displayName":"Topics","name":"topics","type":"string","default":"","description":"Topics to subscribe to, multiple can be defined with comma. Wildcard characters are supported (+ - for single level and # - for multi level). By default all subscription used QoS=0. To set a different QoS, write the QoS desired after the topic preceded by a colom. For Example: topicA:1,topicB:2"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"JSON Parse Body","name":"jsonParseBody","type":"boolean","default":false,"description":"Whether to try parse the message to an object"},{"displayName":"Only Message","name":"onlyMessage","type":"boolean","default":false,"description":"Whether to return only the message property"},{"displayName":"Parallel Processing","name":"parallelProcessing","type":"boolean","default":true,"description":"Whether to process messages in parallel or by keeping the message in order"}]}]


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

  # MSG91 node

  Use the MSG91 node to automate work in MSG91, and integrate MSG91 with other applications. n8n supports sending SMS with MSG91.

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

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

  ## Operations

  * SMS
      * Send SMS

  ## Templates and examples

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

  ## Find your Sender ID

  1. Log in to your MSG91 dashboard.
  2. Select **Sender Id** in the left panel.
  3. If you don't already have one, select **Add Sender Id +**, fill in the details, and select **Save Sender Id**.

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"SMS","value":"sms"}],"default":"sms"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["sms"]}},"options":[{"name":"Send","value":"send","description":"Send SMS","action":"Send an SMS"}],"default":"send"},{"displayName":"Sender ID","name":"from","type":"string","default":"","placeholder":"4155238886","required":true,"displayOptions":{"show":{"operation":["send"],"resource":["sms"]}},"description":"The number from which to send the message"},{"displayName":"To","name":"to","type":"string","default":"","placeholder":"+14155238886","required":true,"displayOptions":{"show":{"operation":["send"],"resource":["sms"]}},"description":"The number, with coutry code, to which to send the message"},{"displayName":"Message","name":"message","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["send"],"resource":["sms"]}},"description":"The message to send"}]

operations:
  [{"type":"resource","resource":"sms","name":"SMS"},{"type":"operation","operation":"send","name":"Send","action":"Send an SMS","resources":["sms"]}]


node_type: mySql
package_name: n8n-nodes-base
display_name: MySQL
description: Get, add and update data in MySQL
category: input
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: MySQL node documentation
  description: Learn how to use the MySQL node in n8n. Follow technical documentation to integrate MySQL node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # MySQL node

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

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

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

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

  ## Operations

  * Delete
  * Execute SQL
  * Insert
  * Insert or Update
  * Select
  * Update

  ## Templates and examples

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

  ## Related resources

  Refer to [MySQL's Connectors and APIs documentation](https://dev.mysql.com/doc/index-connectors.html){:target=_blank .external-link} for more information about the service.

  Refer to MySQL's [SELECT statement documentation](https://dev.mysql.com/doc/refman/8.4/en/select.html){:target=_blank .external-link} for more information on writing SQL queries.

  ## Use query parameters

  When creating a query to run on a MySQL database, you can use the **Query Parameters** field in the **Options** section to load data into the query. n8n sanitizes data in query parameters, which prevents SQL injection.

  For example, you want to find a person by their email address. Given the following input data:

  ```js
  [
      {
          "email": "alex@example.com",
          "name": "Alex",
          "age": 21 
      },
      {
          "email": "jamie@example.com",
          "name": "Jamie",
          "age": 33 
      }
  ]
  ```

  You can write a query like:

  ```sql
  SELECT * FROM $1:name WHERE email = $2;
  ```

  Then in **Query Parameters**, provide the field values to use. You can provide fixed values or expressions. For this example, use expressions so the node can pull the email address from each input item in turn:

  ```js
  // users is an example table name
  users, {{ $json.email }} 
  ```

  ## Common issues

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


node_type: n8n
package_name: n8n-nodes-base
display_name: n8n
description: Handle events and perform actions on your n8n instance
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"n8nApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: n8n
  description: Documentation for the n8n node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # n8n

  A node to integrate with n8n itself. This node allows you to consume the [n8n API](/api/index.md) in your workflows.

  Refer to the [n8n REST API documentation](/api/index.md) for more information on using the n8n API. Refer to [API endpoint reference](/api/api-reference.md) for working with the API endpoints directly.

  /// note | Credentials
  You can find authentication information for this node in the [API authentication](/api/authentication.md) documentation.
  ///

  /// warning | SSL
  This node doesn't support SSL. If your server requires an SSL connection, use the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to call the [n8n API](/api/index.md).
  The HTTP Request node has options to [provide the SSL certificate](/integrations/builtin/credentials/httprequest.md#provide-an-ssl-certificate).
  ///

  ## Operations

  * Audit
  	* [**Generate** a security audit](#generate-audit)
  * Credential
  	* [**Create** a credential](#create-credential)
  	* [**Delete** a credential](#delete-credential)
  	* [**Get Schema**](#get-credential-schema): Use this operation to get credential data schema for type
  * Execution
  	* [**Get** an execution](#get-execution)
  	* [**Get Many** executions](#get-many-executions)
  	* [**Delete** an execution](#delete-execution)
  * Workflow
  	* [**Activate** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Create** a workflow](#create-workflow)
  	* [**Deactivate** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Delete** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Get** a workflow](#activate-deactivate-delete-and-get-workflow)
  	* [**Get Many** workflows](#get-many-workflows)
  	* [**Update** a workflow](#update-workflow)

  ## Generate audit

  This operation has no parameters. Configure it with these options:

  * **Categories**: Select the risk categories you want the audit to include. Options include:
  	* **Credentials**
  	* **Database**
  	* **Filesystem**
  	* **Instance**
  	* **Nodes**
  * **Days Abandoned Workflow**: Use this option to set the number of days without execution after which a workflow should be considered abandoned. Enter a number of days. The default is `90`.

  ## Create credential

  Configure this operation with these parameters:

  * **Name**: Enter the name of the credential you'd like to create.
  * **Credential Type**: Enter the credential's type. The available types depend on nodes installed on the n8n instance. Some built-in types include `githubApi`, `notionApi`, and `slackApi`.
  * **Data**: Enter a valid JSON object with the required properties for this **Credential Type**. To see the expected format, use the **Get Schema** operation.

  ## Delete credential

  Configure this operation with this parameter:

  * **Credential ID**: Enter the ID of the credential you want to delete.

  ## Get credential schema

  Configure this operation with this parameter:

  * **Credential Type**: Enter the credential's type. The available types depend on nodes installed on the n8n instance. Some built-in types include `githubApi`, `notionApi`, and `slackApi`.

  ## Get execution

  Configure this operation with this parameter:

  * **Execution ID**: Enter the ID of the execution you want to retrieve.

  ### Get execution option

  You can further configure this operation with this **Option**:

  * **Include Execution Details**: Use this control to set whether to include the detailed execution data (turned on) or not (turned off).

  ## Get many executions

  Configure this operation with these parameters:

  * **Return All**: Set whether to return all results (turned on) or whether to limit the results to the entered **Limit** (turned on).
  * **Limit**: Set the number of results to return if the **Return All** control is turned off.

  ### Get many executions filters

  You can further configure this operation with these **Filters**:

  * **Workflow**: Filter the executions by workflow. Options include:
  	* **From list**: Select a workflow to use as a filter.
  	* **By URL**: Enter a workflow URL to use as a filter.
  	* **By ID**: Enter a workflow ID to use as a filter.
  * **Status**: Filter the executions by status. Options include:
  	* **Error**
  	* **Success**
  	* **Waiting**

  ### Get many execution options

  You can further configure this operation with this **Option**:

  * **Include Execution Details**: Use this control to set whether to include the detailed execution data (turned on) or not (turned off).

  ## Delete execution

  Configure this operation with this parameter:

  * **Execution ID**: Enter the ID of the execution you want to delete.

  ## Activate, deactivate, delete, and get workflow

  The **Activate**, **Deactivate**, **Delete**, and **Get** workflow operations all include the same parameter for you to select the **Workflow** you want to perform the operation on. Options include:

  * **From list**: Select the workflow from the list.
  * **By URL**: Enter the URL of the workflow.
  * **By ID**: Enter the ID of the workflow.

  ## Create workflow

  Configure this operation with this parameter:

  * **Workflow Object**: Enter a valid JSON object with the new workflow's details. The object requires these fields:
  	* `name`
  	* `nodes`
  	* `connections`
  	* `settings`

  Refer to the [n8n API | Create a workflow documentation](/api/api-reference.md/#tag/Workflow/paths/~1workflows/post) for more information.

  ## Get many workflows

  Configure this operation with these parameters:

  * **Return All**: Set whether to return all results (turned on) or whether to limit the results to the entered **Limit** (turned on).
  * **Limit**: Set the number of results to return if the **Return All** control is turned off.

  ### Get many workflows filters

  You can further configure this operation with these **Filters**:

  * **Return Only Active Workflows**: Select whether to return only active workflows (turned on) or active and inactive workflows (turned off).
  * **Tags**: Enter a comma-separated list of tags the returned workflows must have.

  ## Update workflow

  Configure this operation with these parameters:

  * **Workflow**: Select the workflow you want to update. Options include:
  	* **From list**: Select the workflow from the list.
  	* **By URL**: Enter the URL of the workflow.
  	* **By ID**: Enter the ID of the workflow.
  * **Workflow Object**: Enter a valid JSON object to update the workflow with. The object requires these fields:
  	* `name`
  	* `nodes`
  	* `connections`
  	* `settings`

  Refer to the [n8n API | Update a workflow documentation](https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows~1%7Bid%7D/put) for more information.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Audit","value":"audit"},{"name":"Credential","value":"credential"},{"name":"Execution","value":"execution"},{"name":"Workflow","value":"workflow"}],"default":"workflow"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"get","displayOptions":{"show":{"resource":["audit"]}},"options":[{"name":"Generate","value":"generate","action":"Generate a security audit","description":"Generate a security audit for this n8n instance","routing":{"request":{"method":"POST","url":"/audit"}}}]},{"displayName":"Additional Options","name":"additionalOptions","type":"collection","placeholder":"Add Filter","displayOptions":{"show":{"resource":["audit"]}},"routing":{"request":{"body":{"additionalOptions":"={{ $value }}"}}},"default":{},"options":[{"displayName":"Categories","name":"categories","description":"Risk categories to include in the audit","type":"multiOptions","default":[],"options":[{"name":"Credentials","value":"credentials"},{"name":"Database","value":"database"},{"name":"Filesystem","value":"filesystem"},{"name":"Instance","value":"instance"},{"name":"Nodes","value":"nodes"}]},{"displayName":"Days Abandoned Workflow","name":"daysAbandonedWorkflow","description":"Days for a workflow to be considered abandoned if not executed","type":"number","default":90}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"create","displayOptions":{"show":{"resource":["credential"]}},"options":[{"name":"Create","value":"create","action":"Create a credential","routing":{"request":{"method":"POST","url":"/credentials"}}},{"name":"Delete","value":"delete","action":"Delete a credential","routing":{"request":{"method":"DELETE","url":"=/credentials/{{ $parameter.credentialId }}"}}},{"name":"Get Schema","value":"getSchema","action":"Get credential data schema for type","routing":{"request":{"method":"GET","url":"=/credentials/schema/{{ $parameter.credentialTypeName }}"}}}]},{"displayName":"Name","name":"name","type":"string","default":"","placeholder":"e.g. n8n account","required":true,"displayOptions":{"show":{"resource":["credential"],"operation":["create"]}},"routing":{"request":{"body":{"name":"={{ $value }}"}}},"description":"Name of the new credential"},{"displayName":"Credential Type","name":"credentialTypeName","type":"string","placeholder":"e.g. n8nApi","default":"","required":true,"displayOptions":{"show":{"resource":["credential"],"operation":["create"]}},"routing":{"request":{"body":{"type":"={{ $value }}"}}},"description":"The available types depend on nodes installed on the n8n instance. Some built-in types include e.g. 'githubApi', 'notionApi', and 'slackApi'."},{"displayName":"Data","name":"data","type":"json","default":"","placeholder":"// e.g. for n8nApi \n{\n  \"apiKey\": \"my-n8n-api-key\",\n  \"baseUrl\": \"https://<name>.app.n8n.cloud/api/v1\",\n}","required":true,"typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["credential"],"operation":["create"]}},"routing":{"send":{"preSend":[null]}},"description":"A valid JSON object with properties required for this Credential Type. To see the expected format, you can use 'Get Schema' operation."},{"displayName":"Credential ID","name":"credentialId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["credential"],"operation":["delete"]}}},{"displayName":"Credential Type","name":"credentialTypeName","default":"","placeholder":"e.g. n8nApi","required":true,"type":"string","displayOptions":{"show":{"resource":["credential"],"operation":["getSchema"]}},"description":"The available types depend on nodes installed on the n8n instance. Some built-in types include e.g. 'githubApi', 'notionApi', and 'slackApi'."},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"getAll","displayOptions":{"show":{"resource":["execution"]}},"options":[{"name":"Get","value":"get","action":"Get an execution","routing":{"request":{"method":"GET","url":"=/executions/{{ $parameter.executionId }}"}}},{"name":"Get Many","value":"getAll","action":"Get many executions","routing":{"request":{"method":"GET","url":"/executions"},"send":{"paginate":true},"operations":{}}},{"name":"Delete","value":"delete","action":"Delete an execution","routing":{"request":{"method":"DELETE","url":"=/executions/{{ $parameter.executionId }}"}}}]},{"displayName":"Execution ID","name":"executionId","type":"string","required":true,"displayOptions":{"show":{"resource":["execution"],"operation":["delete"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"displayOptions":{"show":{"resource":["execution"],"operation":["getAll"]}},"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":100,"typeOptions":{"minValue":1,"maxValue":250},"displayOptions":{"show":{"resource":["execution"],"operation":["getAll"],"returnAll":[false]}},"routing":{"request":{"qs":{"limit":"={{ $value }}"}}},"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["execution"],"operation":["getAll"]}},"options":[{"displayName":"Workflow","name":"workflowId","type":"resourceLocator","default":{"mode":"list","value":""},"description":"Workflow to filter the executions by","modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a Workflow...","initType":"workflow","typeOptions":{"searchListMethod":"searchWorkflows","searchFilterRequired":false,"searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://myinstance.app.n8n.cloud/workflow/1","validation":[{"type":"regex","properties":{"regex":".*/workflow/([0-9a-zA-Z]{1,})","errorMessage":"Not a valid Workflow URL"}}],"extractValue":{"type":"regex","regex":".*/workflow/([0-9a-zA-Z]{1,})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-zA-Z]{1,}","errorMessage":"Not a valid Workflow ID"}}],"placeholder":"1"}],"routing":{"send":{"type":"query","property":"workflowId","value":"={{ $value || undefined }}"}}},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Error","value":"error"},{"name":"Success","value":"success"},{"name":"Waiting","value":"waiting"}],"default":"success","routing":{"send":{"type":"query","property":"status","value":"={{ $value }}"}},"description":"Status to filter the executions by"}]},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Option","displayOptions":{"show":{"resource":["execution"],"operation":["getAll"]}},"options":[{"displayName":"Include Execution Details","name":"activeWorkflows","type":"boolean","default":false,"routing":{"send":{"type":"query","property":"includeData","value":"={{ $value }}"}},"description":"Whether to include the detailed execution data"}]},{"displayName":"Execution ID","name":"executionId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["execution"],"operation":["get"]}}},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Option","displayOptions":{"show":{"resource":["execution"],"operation":["get"]}},"options":[{"displayName":"Include Execution Details","name":"activeWorkflows","type":"boolean","default":false,"routing":{"send":{"type":"query","property":"includeData","value":"={{ $value }}"}},"description":"Whether to include the detailed execution data"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"getAll","displayOptions":{"show":{"resource":["workflow"]}},"options":[{"name":"Activate","value":"activate","action":"Activate a workflow"},{"name":"Create","value":"create","action":"Create a workflow","routing":{"request":{"method":"POST","url":"/workflows"}}},{"name":"Deactivate","value":"deactivate","action":"Deactivate a workflow"},{"name":"Delete","value":"delete","action":"Delete a workflow"},{"name":"Get","value":"get","action":"Get a workflow"},{"name":"Get Many","value":"getAll","action":"Get many workflows","routing":{"request":{"method":"GET","url":"/workflows"},"send":{"paginate":true},"operations":{}}},{"name":"Update","value":"update","action":"Update a workflow"}]},{"displayName":"Workflow","name":"workflowId","type":"resourceLocator","default":{"mode":"list","value":""},"description":"Workflow to filter the executions by","modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a Workflow...","initType":"workflow","typeOptions":{"searchListMethod":"searchWorkflows","searchFilterRequired":false,"searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://myinstance.app.n8n.cloud/workflow/1","validation":[{"type":"regex","properties":{"regex":".*/workflow/([0-9a-zA-Z]{1,})","errorMessage":"Not a valid Workflow URL"}}],"extractValue":{"type":"regex","regex":".*/workflow/([0-9a-zA-Z]{1,})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-zA-Z]{1,}","errorMessage":"Not a valid Workflow ID"}}],"placeholder":"1"}],"required":true,"displayOptions":{"show":{"resource":["workflow"],"operation":["activate"]}},"routing":{"request":{"method":"POST","url":"=/workflows/{{ $value }}/activate"}}},{"displayName":"Workflow Object","name":"workflowObject","type":"json","default":"{ \"name\": \"My workflow\", \"nodes\": [], \"connections\": {}, \"settings\": {} }","placeholder":"{\n  \"name\": \"My workflow\",\n  \"nodes\": [],\n  \"connections\": {},\n  \"settings\": {}\n}","required":true,"typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["workflow"],"operation":["create"]}},"routing":{"send":{"preSend":[null,null]}},"description":"A valid JSON object with required fields: 'name', 'nodes', 'connections' and 'settings'. More information can be found in the <a href=\"https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows/post\">documentation</a>."},{"displayName":"Workflow","name":"workflowId","type":"resourceLocator","default":{"mode":"list","value":""},"description":"Workflow to filter the executions by","modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a Workflow...","initType":"workflow","typeOptions":{"searchListMethod":"searchWorkflows","searchFilterRequired":false,"searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://myinstance.app.n8n.cloud/workflow/1","validation":[{"type":"regex","properties":{"regex":".*/workflow/([0-9a-zA-Z]{1,})","errorMessage":"Not a valid Workflow URL"}}],"extractValue":{"type":"regex","regex":".*/workflow/([0-9a-zA-Z]{1,})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-zA-Z]{1,}","errorMessage":"Not a valid Workflow ID"}}],"placeholder":"1"}],"required":true,"displayOptions":{"show":{"resource":["workflow"],"operation":["deactivate"]}},"routing":{"request":{"method":"POST","url":"=/workflows/{{ $value }}/deactivate"}}},{"displayName":"Workflow","name":"workflowId","type":"resourceLocator","default":{"mode":"list","value":""},"description":"Workflow to filter the executions by","modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a Workflow...","initType":"workflow","typeOptions":{"searchListMethod":"searchWorkflows","searchFilterRequired":false,"searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://myinstance.app.n8n.cloud/workflow/1","validation":[{"type":"regex","properties":{"regex":".*/workflow/([0-9a-zA-Z]{1,})","errorMessage":"Not a valid Workflow URL"}}],"extractValue":{"type":"regex","regex":".*/workflow/([0-9a-zA-Z]{1,})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-zA-Z]{1,}","errorMessage":"Not a valid Workflow ID"}}],"placeholder":"1"}],"required":true,"displayOptions":{"show":{"resource":["workflow"],"operation":["delete"]}},"routing":{"request":{"method":"DELETE","url":"=/workflows/{{ $value }}"}}},{"displayName":"Return All","name":"returnAll","type":"boolean","default":true,"displayOptions":{"show":{"resource":["workflow"],"operation":["getAll"]}},"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":100,"typeOptions":{"minValue":1,"maxValue":250},"displayOptions":{"show":{"resource":["workflow"],"operation":["getAll"],"returnAll":[false]}},"routing":{"request":{"qs":{"limit":"={{ $value }}"}}},"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","default":{},"displayOptions":{"show":{"resource":["workflow"],"operation":["getAll"]}},"options":[{"displayName":"Return Only Active Workflows","name":"activeWorkflows","type":"boolean","default":true,"routing":{"request":{"qs":{"active":"={{ $value }}"}}}},{"displayName":"Tags","name":"tags","type":"string","default":"","routing":{"send":{"type":"query","property":"tags","value":"={{ $value !== \"\" ? $value : undefined }}"}},"description":"Include only workflows with these tags","hint":"Comma separated list of tags (empty value is ignored)"}]},{"displayName":"Workflow","name":"workflowId","type":"resourceLocator","default":{"mode":"list","value":""},"description":"Workflow to filter the executions by","modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a Workflow...","initType":"workflow","typeOptions":{"searchListMethod":"searchWorkflows","searchFilterRequired":false,"searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://myinstance.app.n8n.cloud/workflow/1","validation":[{"type":"regex","properties":{"regex":".*/workflow/([0-9a-zA-Z]{1,})","errorMessage":"Not a valid Workflow URL"}}],"extractValue":{"type":"regex","regex":".*/workflow/([0-9a-zA-Z]{1,})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-zA-Z]{1,}","errorMessage":"Not a valid Workflow ID"}}],"placeholder":"1"}],"required":true,"displayOptions":{"show":{"resource":["workflow"],"operation":["get"]}},"routing":{"request":{"method":"GET","url":"=/workflows/{{ $value }}"}}},{"displayName":"Workflow","name":"workflowId","type":"resourceLocator","default":{"mode":"list","value":""},"description":"Workflow to filter the executions by","modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a Workflow...","initType":"workflow","typeOptions":{"searchListMethod":"searchWorkflows","searchFilterRequired":false,"searchable":true}},{"displayName":"By URL","name":"url","type":"string","placeholder":"https://myinstance.app.n8n.cloud/workflow/1","validation":[{"type":"regex","properties":{"regex":".*/workflow/([0-9a-zA-Z]{1,})","errorMessage":"Not a valid Workflow URL"}}],"extractValue":{"type":"regex","regex":".*/workflow/([0-9a-zA-Z]{1,})"}},{"displayName":"ID","name":"id","type":"string","validation":[{"type":"regex","properties":{"regex":"[0-9a-zA-Z]{1,}","errorMessage":"Not a valid Workflow ID"}}],"placeholder":"1"}],"required":true,"displayOptions":{"show":{"resource":["workflow"],"operation":["update"]}},"routing":{"request":{"method":"PUT","url":"=/workflows/{{ $value }}"}}},{"displayName":"Workflow Object","name":"workflowObject","type":"json","default":"","placeholder":"{\n  \"name\": \"My workflow\",\n  \"nodes\": [],\n  \"connections\": {},\n  \"settings\": {}\n}","required":true,"typeOptions":{"alwaysOpenEditWindow":true},"displayOptions":{"show":{"resource":["workflow"],"operation":["update"]}},"routing":{"send":{"preSend":[null,null]}},"description":"A valid JSON object with required fields: 'name', 'nodes', 'connections' and 'settings'. More information can be found in the <a href=\"https://docs.n8n.io/api/api-reference/#tag/Workflow/paths/~1workflows~1%7Bid%7D/put\">documentation</a>."}]

operations:
  [{"type":"resource","resource":"audit","name":"Audit"},{"type":"resource","resource":"credential","name":"Credential"},{"type":"resource","resource":"execution","name":"Execution"},{"type":"resource","resource":"workflow","name":"Workflow"},{"type":"operation","operation":"generate","name":"Generate","action":"Generate a security audit","resources":["audit"]},{"type":"operation","operation":"create","name":"Create","action":"Create a credential","resources":["credential"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a credential","resources":["credential"]},{"type":"operation","operation":"getSchema","name":"Get Schema","action":"Get credential data schema for type","resources":["credential"]},{"type":"operation","operation":"get","name":"Get","action":"Get an execution","resources":["execution"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many executions","resources":["execution"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an execution","resources":["execution"]},{"type":"operation","operation":"activate","name":"Activate","action":"Activate a workflow","resources":["workflow"]},{"type":"operation","operation":"create","name":"Create","action":"Create a workflow","resources":["workflow"]},{"type":"operation","operation":"deactivate","name":"Deactivate","action":"Deactivate a workflow","resources":["workflow"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a workflow","resources":["workflow"]},{"type":"operation","operation":"get","name":"Get","action":"Get a workflow","resources":["workflow"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many workflows","resources":["workflow"]},{"type":"operation","operation":"update","name":"Update","action":"Update a workflow","resources":["workflow"]}]


node_type: n8nTrainingCustomerDatastore
package_name: n8n-nodes-base
display_name: Customer Datastore (n8n training)
description: Dummy node used for n8n training
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: Customer Datastore (n8n Training) node documentation
  description: Learn how to use the Customer Datastore (n8n Training) node in n8n. Follow technical documentation to integrate Customer Datastore (n8n Training) node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Customer Datastore (n8n Training) node

  Use this node only for the n8n new user onboarding tutorial. It provides dummy data for testing purposes and has no further functionality.

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Get One Person","value":"getOnePerson"},{"name":"Get All People","value":"getAllPeople"}],"default":"getOnePerson"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAllPeople"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAllPeople"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":10},"default":5,"description":"Max number of results to return"}]


node_type: n8nTrainingCustomerMessenger
package_name: n8n-nodes-base
display_name: Customer Messenger (n8n training)
description: Dummy node used for n8n training
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: Customer Messenger (n8n Training) node documentation
  description: Learn how to use the Customer Messenger (n8n Training) node in n8n. Follow technical documentation to integrate Customer Messenger (n8n Training) node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Customer Messenger (n8n Training) node

  Use this node only for the n8n new user onboarding tutorial. It provides no further functionality.

properties_schema:
  [{"displayName":"Customer ID","name":"customerId","type":"string","required":true,"default":""},{"displayName":"Message","name":"message","type":"string","required":true,"typeOptions":{"rows":4},"default":""}]


node_type: n8nTrigger
package_name: n8n-nodes-base
display_name: n8n Trigger
description: Handle events and perform actions on your n8n instance
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 Trigger node documentation
  description: Learn how to use the n8n Trigger node in n8n. Follow technical documentation to integrate n8n Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # n8n Trigger node

  The n8n Trigger node triggers when the current workflow updates or activates, or when the n8n instance starts or restarts. You can use the n8n Trigger node to notify when these events occur.

  ## Node parameters

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

  - **Active Workflow Updated**: If you select this event, the node triggers when this workflow is updated.
  - **Instance started**: If you select this event, the node triggers when the n8n instance starts or restarts.
  - **Workflow Activated**: If you select this event, the node triggers when this workflow is activated.

  You can select one or more of these events.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Events","name":"events","type":"multiOptions","required":true,"default":[],"description":"Specifies under which conditions an execution should happen: <b>Instance started</b>: Triggers when this n8n instance is started or re-started","options":[{"name":"Instance Started","value":"init","description":"Triggers when this n8n instance is started or re-started"}]}]


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

  # NASA node

  Use the NASA node to automate work in NASA, and integrate NASA with other applications. n8n has built-in support for a wide range of NASA features, including retrieving imagery and data. 

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

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

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

  ## Operations

  * Astronomy Picture of the Day
      * Get the Astronomy Picture of the Day
  * Asteroid Neo-Feed
      * Retrieve a list of asteroids based on their closest approach date to Earth
  * Asteroid Neo-Lookup
      * Look up an asteroid based on its NASA SPK-ID
  * Asteroid Neo-Browse
      * Browse the overall asteroid dataset
  * DONKI Coronal Mass Ejection
      * Retrieve DONKI coronal mass ejection data
  * DONKI Interplanetary Shock
      * Retrieve DONKI interplanetary shock data
  * DONKI Solar Flare
      * Retrieve DONKI solar flare data
  * DONKI Solar Energetic Particle
      * Retrieve DONKI solar energetic particle data
  * DONKI Magnetopause Crossing
      * Retrieve data on DONKI magnetopause crossings
  * DONKI Radiation Belt Enhancement
      * Retrieve DONKI radiation belt enhancement data
  * DONKI High Speed Stream
      * Retrieve DONKI high speed stream data
  * DONKI WSA+EnlilSimulation
      * Retrieve DONKI WSA+EnlilSimulation data
  * DONKI Notifications
      * Retrieve DONKI notifications data
  * Earth Imagery
      * Retrieve Earth imagery
  * Earth Assets
      * Retrieve Earth assets

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Asteroid Neo-Browse","value":"asteroidNeoBrowse"},{"name":"Asteroid Neo-Feed","value":"asteroidNeoFeed"},{"name":"Asteroid Neo-Lookup","value":"asteroidNeoLookup"},{"name":"Astronomy Picture of the Day","value":"astronomyPictureOfTheDay"},{"name":"DONKI Coronal Mass Ejection","value":"donkiCoronalMassEjection"},{"name":"DONKI High Speed Stream","value":"donkiHighSpeedStream"},{"name":"DONKI Interplanetary Shock","value":"donkiInterplanetaryShock"},{"name":"DONKI Magnetopause Crossing","value":"donkiMagnetopauseCrossing"},{"name":"DONKI Notification","value":"donkiNotifications"},{"name":"DONKI Radiation Belt Enhancement","value":"donkiRadiationBeltEnhancement"},{"name":"DONKI Solar Energetic Particle","value":"donkiSolarEnergeticParticle"},{"name":"DONKI Solar Flare","value":"donkiSolarFlare"},{"name":"DONKI WSA+EnlilSimulation","value":"donkiWsaEnlilSimulation"},{"name":"Earth Asset","value":"earthAssets"},{"name":"Earth Imagery","value":"earthImagery"}],"default":"astronomyPictureOfTheDay"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["astronomyPictureOfTheDay"]}},"options":[{"name":"Get","value":"get","description":"Get the Astronomy Picture of the Day","action":"Get the astronomy picture of the day"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["asteroidNeoFeed"]}},"options":[{"name":"Get","value":"get","description":"Retrieve a list of asteroids based on their closest approach date to Earth","action":"Get an asteroid neo feed"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["asteroidNeoLookup"]}},"options":[{"name":"Get","value":"get","description":"Look up an asteroid based on its NASA SPK-ID","action":"Get an asteroid neo lookup"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["asteroidNeoBrowse"]}},"options":[{"name":"Get Many","value":"getAll","description":"Browse the overall asteroid dataset","action":"Get many asteroid neos"}],"default":"getAll"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiCoronalMassEjection"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI coronal mass ejection data","action":"Get a DONKI coronal mass ejection"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiGeomagneticStorm"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI geomagnetic storm data","action":"Get a DONKI geomagnetic storm"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiInterplanetaryShock"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI interplanetary shock data","action":"Get a DONKI interplanetary shock"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiSolarFlare"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI solar flare data","action":"Get a DONKI solar flare"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiSolarEnergeticParticle"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI solar energetic particle data","action":"Get a DONKI solar energetic particle"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiMagnetopauseCrossing"]}},"options":[{"name":"Get","value":"get","description":"Retrieve data on DONKI magnetopause crossings","action":"Get a DONKI magnetopause crossing"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiRadiationBeltEnhancement"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI radiation belt enhancement data","action":"Get a DONKI radiation belt enhancement"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiHighSpeedStream"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI high speed stream data","action":"Get a DONKI high speed stream"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiWsaEnlilSimulation"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI WSA+EnlilSimulation data","action":"Get a DONKI wsa enlil simulation"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["donkiNotifications"]}},"options":[{"name":"Get","value":"get","description":"Retrieve DONKI notifications data","action":"Get a DONKI notifications"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["earthImagery"]}},"options":[{"name":"Get","value":"get","description":"Retrieve Earth imagery","action":"Get Earth imagery"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["earthAssets"]}},"options":[{"name":"Get","value":"get","description":"Retrieve Earth assets","action":"Get Earth assets"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["inSightMarsWeatherService"]}},"options":[{"name":"Get","value":"get","description":"Retrieve Insight Mars Weather Service data","action":"Get Insight Mars Weather Service"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["imageAndVideoLibrary"]}},"options":[{"name":"Get","value":"get","description":"Retrieve Image and Video Library data","action":"Get image and video library data"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["techTransfer"]}},"options":[{"name":"Get","value":"get","description":"Retrieve TechTransfer data","action":"Get a TechTransfer data"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["twoLineElementSet"]}},"options":[{"name":"Get","value":"get","description":"Retrieve Two-Line Element Set data","action":"Get a Two-Line Element Set"}],"default":"get"},{"displayName":"Asteroid ID","name":"asteroidId","type":"string","required":true,"default":"","placeholder":"3542519","description":"The ID of the asteroid to be returned","displayOptions":{"show":{"resource":["asteroidNeoLookup"],"operation":["get"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["asteroidNeoLookup"],"operation":["get"]}},"options":[{"displayName":"Include Close Approach Data","name":"includeCloseApproachData","type":"boolean","default":false,"description":"Whether to include all the close approach data in the asteroid lookup"}]},{"displayName":"Download Image","name":"download","type":"boolean","displayOptions":{"show":{"resource":["astronomyPictureOfTheDay"]}},"default":true,"description":"By default just the URL of the image is returned. When set to true the image will be downloaded."},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","required":true,"default":"data","displayOptions":{"show":{"operation":["get"],"resource":["astronomyPictureOfTheDay"],"download":[true]}},"description":"Name of the binary property to which to write to"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add field","displayOptions":{"show":{"resource":["astronomyPictureOfTheDay"],"operation":["get"]}},"options":[{"displayName":"Date","name":"date","type":"dateTime","default":"","placeholder":"YYYY-MM-DD"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add field","displayOptions":{"show":{"resource":["asteroidNeoFeed","donkiCoronalMassEjection","donkiGeomagneticStorm","donkiSolarFlare","donkiSolarEnergeticParticle","donkiMagnetopauseCrossing","donkiRadiationBeltEnhancement","donkiHighSpeedStream","donkiWsaEnlilSimulation","donkiNotifications"],"operation":["get"]}},"options":[{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","placeholder":"YYYY-MM-DD"},{"displayName":"End Date","name":"endDate","type":"dateTime","default":"","placeholder":"YYYY-MM-DD"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add field","displayOptions":{"show":{"resource":["donkiInterplanetaryShock"],"operation":["get"]}},"options":[{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","placeholder":"YYYY-MM-DD"},{"displayName":"End Date","name":"endDate","type":"dateTime","default":"","placeholder":"YYYY-MM-DD"},{"displayName":"Location","name":"location","type":"options","default":"ALL","description":"The location of the geomagnetic storm","options":[{"name":"All","value":"ALL"},{"name":"Earth","value":"earth"},{"name":"Messenger","value":"MESSENGER"},{"name":"Stereo A","value":"STEREO A"},{"name":"Stereo B","value":"STEREO B"}]},{"displayName":"Catalog","name":"catalog","type":"options","default":"ALL","description":"The catalog of the geomagnetic storm","options":[{"name":"All","value":"ALL"},{"name":"SWRC Catalog","value":"SWRC_CATALOG"},{"name":"Winslow Messenger ICME Catalog","value":"WINSLOW_MESSENGER_ICME_CATALOG"}]}]},{"displayName":"Latitude","name":"lat","type":"number","default":"","placeholder":"47.751076","description":"Latitude for the location of the image","displayOptions":{"show":{"resource":["earthImagery","earthAssets"],"operation":["get"]}}},{"displayName":"Longitude","name":"lon","type":"number","default":"","placeholder":"-120.740135","description":"Longitude for the location of the image","displayOptions":{"show":{"resource":["earthImagery","earthAssets"],"operation":["get"]}}},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","required":true,"default":"data","displayOptions":{"show":{"operation":["get"],"resource":["earthImagery"]}},"description":"Name of the binary property to which to write to"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add field","displayOptions":{"show":{"resource":["earthImagery","earthAssets"],"operation":["get"]}},"options":[{"displayName":"Date","name":"date","type":"dateTime","default":"","placeholder":"YYYY-MM-DD","description":"Date of the image"},{"displayName":"Degrees","name":"dim","type":"number","default":"","placeholder":"0.025","description":"Width and height of the image in degrees"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","typeOptions":{"minValue":1},"description":"Max number of results to return","default":20,"displayOptions":{"show":{"operation":["getAll"],"returnAll":[false]}}}]

operations:
  [{"type":"resource","resource":"asteroidNeoBrowse","name":"Asteroid Neo-Browse"},{"type":"resource","resource":"asteroidNeoFeed","name":"Asteroid Neo-Feed"},{"type":"resource","resource":"asteroidNeoLookup","name":"Asteroid Neo-Lookup"},{"type":"resource","resource":"astronomyPictureOfTheDay","name":"Astronomy Picture of the Day"},{"type":"resource","resource":"donkiCoronalMassEjection","name":"DONKI Coronal Mass Ejection"},{"type":"resource","resource":"donkiHighSpeedStream","name":"DONKI High Speed Stream"},{"type":"resource","resource":"donkiInterplanetaryShock","name":"DONKI Interplanetary Shock"},{"type":"resource","resource":"donkiMagnetopauseCrossing","name":"DONKI Magnetopause Crossing"},{"type":"resource","resource":"donkiNotifications","name":"DONKI Notification"},{"type":"resource","resource":"donkiRadiationBeltEnhancement","name":"DONKI Radiation Belt Enhancement"},{"type":"resource","resource":"donkiSolarEnergeticParticle","name":"DONKI Solar Energetic Particle"},{"type":"resource","resource":"donkiSolarFlare","name":"DONKI Solar Flare"},{"type":"resource","resource":"donkiWsaEnlilSimulation","name":"DONKI WSA+EnlilSimulation"},{"type":"resource","resource":"earthAssets","name":"Earth Asset"},{"type":"resource","resource":"earthImagery","name":"Earth Imagery"},{"type":"operation","operation":"get","name":"Get","action":"Get the astronomy picture of the day","resources":["astronomyPictureOfTheDay"]},{"type":"operation","operation":"get","name":"Get","action":"Get an asteroid neo feed","resources":["asteroidNeoFeed"]},{"type":"operation","operation":"get","name":"Get","action":"Get an asteroid neo lookup","resources":["asteroidNeoLookup"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many asteroid neos","resources":["asteroidNeoBrowse"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI coronal mass ejection","resources":["donkiCoronalMassEjection"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI geomagnetic storm","resources":["donkiGeomagneticStorm"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI interplanetary shock","resources":["donkiInterplanetaryShock"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI solar flare","resources":["donkiSolarFlare"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI solar energetic particle","resources":["donkiSolarEnergeticParticle"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI magnetopause crossing","resources":["donkiMagnetopauseCrossing"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI radiation belt enhancement","resources":["donkiRadiationBeltEnhancement"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI high speed stream","resources":["donkiHighSpeedStream"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI wsa enlil simulation","resources":["donkiWsaEnlilSimulation"]},{"type":"operation","operation":"get","name":"Get","action":"Get a DONKI notifications","resources":["donkiNotifications"]},{"type":"operation","operation":"get","name":"Get","action":"Get Earth imagery","resources":["earthImagery"]},{"type":"operation","operation":"get","name":"Get","action":"Get Earth assets","resources":["earthAssets"]},{"type":"operation","operation":"get","name":"Get","action":"Get Insight Mars Weather Service","resources":["inSightMarsWeatherService"]},{"type":"operation","operation":"get","name":"Get","action":"Get image and video library data","resources":["imageAndVideoLibrary"]},{"type":"operation","operation":"get","name":"Get","action":"Get a TechTransfer data","resources":["techTransfer"]},{"type":"operation","operation":"get","name":"Get","action":"Get a Two-Line Element Set","resources":["twoLineElementSet"]}]


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

  # Netlify node

  Use the Netlify node to automate work in Netlify, and integrate Netlify with other applications. n8n has built-in support for a wide range of Netlify features, including getting and cancelling deployments, as well as deleting, and getting sites. 

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

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

  ## Operations

  * Deploy
      * Cancel a deployment
      * Create a new deployment
      * Get a deployment
      * Get all deployments
  * Site
      * Delete a site
      * Get a site
      * Returns all sites

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Deploy","value":"deploy"},{"name":"Site","value":"site"}],"default":"deploy","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["deploy"]}},"options":[{"name":"Cancel","value":"cancel","description":"Cancel a deployment","action":"Cancel a deployment"},{"name":"Create","value":"create","description":"Create a new deployment","action":"Create a deployment"},{"name":"Get","value":"get","description":"Get a deployment","action":"Get a deployment"},{"name":"Get Many","value":"getAll","description":"Get many deployments","action":"Get many deployments"}],"default":"getAll"},{"displayName":"Site Name or ID","name":"siteId","required":true,"type":"options","default":"","typeOptions":{"loadOptionsMethod":"getSites"},"description":"Enter the Site ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["deploy"],"operation":["get","create","getAll"]}}},{"displayName":"Deploy ID","name":"deployId","required":true,"type":"string","default":"","displayOptions":{"show":{"resource":["deploy"],"operation":["get","cancel"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["deploy"]}},"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":["deploy"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":50,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Fields","default":{},"displayOptions":{"show":{"resource":["deploy"],"operation":["create"]}},"options":[{"displayName":"Branch","name":"branch","type":"string","default":""},{"displayName":"Title","name":"title","type":"string","default":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["site"]}},"options":[{"name":"Delete","value":"delete","description":"Delete a site","action":"Delete a site"},{"name":"Get","value":"get","description":"Get a site","action":"Get a site"},{"name":"Get Many","value":"getAll","description":"Returns many sites","action":"Get many sites"}],"default":"delete"},{"displayName":"Site ID","name":"siteId","required":true,"type":"string","default":"","displayOptions":{"show":{"resource":["site"],"operation":["get","delete"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["site"]}},"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":["site"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":200},"default":50,"description":"Max number of results to return"}]

operations:
  [{"type":"resource","resource":"deploy","name":"Deploy"},{"type":"resource","resource":"site","name":"Site"},{"type":"operation","operation":"cancel","name":"Cancel","action":"Cancel a deployment","resources":["deploy"]},{"type":"operation","operation":"create","name":"Create","action":"Create a deployment","resources":["deploy"]},{"type":"operation","operation":"get","name":"Get","action":"Get a deployment","resources":["deploy"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many deployments","resources":["deploy"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a site","resources":["site"]},{"type":"operation","operation":"get","name":"Get","action":"Get a site","resources":["site"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many sites","resources":["site"]}]


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

  # Netlify Trigger node

  [Netlify](https://netlify.com/){:target=_blank .external-link} offers hosting and serverless backend services for web applications and static websites.

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

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

  ## Related resources

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

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

properties_schema:
  [{"displayName":"Site Name or ID","name":"siteId","required":true,"type":"options","default":"","typeOptions":{"loadOptionsMethod":"getSites"},"description":"Select the Site ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Event","name":"event","type":"options","required":true,"default":"","options":[{"name":"Deploy Building","value":"deployBuilding"},{"name":"Deploy Failed","value":"deployFailed"},{"name":"Deploy Created","value":"deployCreated"},{"name":"Form Submitted","value":"submissionCreated"}]},{"displayName":"Form Name or ID","name":"formId","type":"options","required":true,"displayOptions":{"show":{"event":["submissionCreated"]}},"default":"","typeOptions":{"loadOptionsMethod":"getForms"},"description":"Select a form. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"event":["submissionCreated"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"}]


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

  # Nextcloud node

  Use the Nextcloud node to automate work in Nextcloud, and integrate Nextcloud with other applications. n8n has built-in support for a wide range of Nextcloud features, including creating, updating, deleting, and getting files, and folders as well as retrieving, and inviting users. 

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

  /// note | Credentials
  Refer to [Nextcloud credentials](/integrations/builtin/credentials/nextcloud.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
      * Share a file
      * Upload a file
  * Folder
      * Copy a folder
      * Create a folder
      * Delete a folder
      * Return the contents of a given folder
      * Move a folder
      * Share a folder
  * User
      * Invite a user to a Nextcloud organization
      * Delete a user.
      * Retrieve information about a single user.
      * Retrieve a list of users.
      * Edit attributes related to a user.

  ## Templates and examples

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

  --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":"File","value":"file"},{"name":"Folder","value":"folder"},{"name":"User","value":"user"}],"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":"Share","value":"share","description":"Share a file","action":"Share 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 contents of a given folder","action":"List a folder"},{"name":"Move","value":"move","description":"Move a folder","action":"Move a folder"},{"name":"Share","value":"share","description":"Share a folder","action":"Share a folder"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Create","value":"create","description":"Invite a user to a NextCloud organization","action":"Create a user"},{"name":"Delete","value":"delete","description":"Delete a user","action":"Delete a user"},{"name":"Get","value":"get","description":"Retrieve information about a single user","action":"Get a user"},{"name":"Get Many","value":"getAll","description":"Retrieve a list of users","action":"Get many users"},{"name":"Update","value":"update","description":"Edit attributes related to a user","action":"Update a user"}],"default":"create"},{"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. The path should start with \"/\"."},{"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. The path should start with \"/\"."},{"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. The path should start with \"/\"."},{"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. The path should start with \"/\"."},{"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. The path should start with \"/\"."},{"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. The path should start with \"/\"."},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"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 absolute 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":"binaryDataUpload","type":"boolean","default":false,"required":true,"displayOptions":{"show":{"operation":["upload"],"resource":["file"]}}},{"displayName":"File Content","name":"fileContent","type":"string","default":"","displayOptions":{"show":{"binaryDataUpload":[false],"operation":["upload"],"resource":["file"]}},"placeholder":"","description":"The text content of the file to upload"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"binaryDataUpload":[true],"operation":["upload"],"resource":["file"]}},"placeholder":"","description":"Name of the binary property which contains the data for the file to be uploaded"},{"displayName":"File Path","name":"path","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["share"],"resource":["file","folder"]}},"placeholder":"/invoices/2019/invoice_1.pdf","description":"The file path of the file to share. Has to contain the full path. The path should start with \"/\"."},{"displayName":"Share Type","name":"shareType","type":"options","displayOptions":{"show":{"operation":["share"],"resource":["file","folder"]}},"options":[{"name":"Circle","value":7},{"name":"Email","value":4},{"name":"Group","value":1},{"name":"Public Link","value":3},{"name":"User","value":0}],"default":0,"description":"The share permissions to set"},{"displayName":"Circle ID","name":"circleId","type":"string","displayOptions":{"show":{"resource":["file","folder"],"operation":["share"],"shareType":[7]}},"default":"","description":"The ID of the circle to share with"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"resource":["file","folder"],"operation":["share"],"shareType":[4]}},"default":"","description":"The Email address to share with"},{"displayName":"Group ID","name":"groupId","type":"string","displayOptions":{"show":{"resource":["file","folder"],"operation":["share"],"shareType":[1]}},"default":"","description":"The ID of the group to share with"},{"displayName":"User","name":"user","type":"string","displayOptions":{"show":{"resource":["file","folder"],"operation":["share"],"shareType":[0]}},"default":"","description":"The user to share with"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["file","folder"],"operation":["share"]}},"options":[{"displayName":"Password","name":"password","type":"string","typeOptions":{"password":true},"displayOptions":{"show":{"/resource":["file","folder"],"/operation":["share"],"/shareType":[3]}},"default":"","description":"Optional search string"},{"displayName":"Permissions","name":"permissions","type":"options","options":[{"name":"All","value":31},{"name":"Create","value":4},{"name":"Delete","value":8},{"name":"Read","value":1},{"name":"Update","value":2}],"default":1,"description":"The share permissions to set"}]},{"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. The path should start with \"/\"."},{"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. The path should start with \"/\"."},{"displayName":"Username","name":"userId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"placeholder":"john","description":"Username the user will have"},{"displayName":"Email","name":"email","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"placeholder":"john@email.com","description":"The email of the user to invite"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"options":[{"displayName":"Display Name","name":"displayName","type":"string","default":"","description":"The display name of the user to invite"}]},{"displayName":"Username","name":"userId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["user"],"operation":["delete","get","update"]}},"placeholder":"john","description":"Username the user will have"},{"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":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"options":[{"displayName":"Search","name":"search","type":"string","default":"","description":"Optional search string"},{"displayName":"Offset","name":"offset","type":"number","default":"","description":"Optional offset value"}]},{"displayName":"Update Fields","name":"updateFields","type":"fixedCollection","typeOptions":{"multipleValues":false},"placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["update"]}},"options":[{"displayName":"Fields","name":"field","values":[{"displayName":"Key","name":"key","type":"options","default":"email","options":[{"name":"Address","value":"address","description":"The new address for the user"},{"name":"Display Name","value":"displayname","description":"The new display name for the user"},{"name":"Email","value":"email","description":"The new email for the user"},{"name":"Password","value":"password","description":"The new password for the user"},{"name":"Twitter","value":"twitter","description":"The new twitter handle for the user"},{"name":"Website","value":"website","description":"The new website for the user"}],"description":"Key of the updated attribute"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the updated attribute"}]}]}]

operations:
  [{"type":"resource","resource":"file","name":"File"},{"type":"resource","resource":"folder","name":"Folder"},{"type":"resource","resource":"user","name":"User"},{"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":"share","name":"Share","action":"Share 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":"share","name":"Share","action":"Share a folder","resources":["folder"]},{"type":"operation","operation":"create","name":"Create","action":"Create a user","resources":["user"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a user","resources":["user"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]},{"type":"operation","operation":"update","name":"Update","action":"Update a user","resources":["user"]}]

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


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

  # NocoDB node

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

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

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

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

  ## Operations

  * Row
      * Create
      * Delete
      * Get
      * Get Many
      * Update a row

  ## Templates and examples

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

  ## Relates resources

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"User Token","value":"nocoDb"},{"name":"API Token","value":"nocoDbApiToken"}],"default":"nocoDb"},{"displayName":"API Version","name":"version","type":"options","displayOptions":{"show":{"@version":[1]}},"isNodeSetting":true,"options":[{"name":"Before v0.90.0","value":1},{"name":"v0.90.0 Onwards","value":2}],"default":1},{"displayName":"API Version","name":"version","type":"options","displayOptions":{"show":{"@version":[2]}},"isNodeSetting":true,"options":[{"name":"Before v0.90.0","value":1},{"name":"v0.90.0 Onwards","value":2}],"default":2},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Row","value":"row"}],"default":"row"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["row"]}},"options":[{"name":"Create","value":"create","description":"Create a row","action":"Create a row"},{"name":"Delete","value":"delete","description":"Delete a row","action":"Delete a row"},{"name":"Get","value":"get","description":"Retrieve a row","action":"Get a row"},{"name":"Get Many","value":"getAll","description":"Retrieve many rows","action":"Get many rows"},{"name":"Update","value":"update","description":"Update a row","action":"Update a row"}],"default":"get"},{"displayName":"Project ID","name":"projectId","type":"string","default":"","displayOptions":{"show":{"version":[1]}},"required":true,"description":"The ID of the project"},{"displayName":"Project Name or ID","name":"projectId","type":"options","default":"","displayOptions":{"show":{"version":[2]}},"required":true,"description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getProjects"}},{"displayName":"Table Name or ID","name":"table","type":"options","default":"","displayOptions":{"show":{"version":[2]}},"required":true,"description":"The table to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","typeOptions":{"loadOptionsDependsOn":["projectId"],"loadOptionsMethod":"getTables"}},{"displayName":"Table","name":"table","type":"string","default":"","displayOptions":{"show":{"version":[1]}},"required":true,"description":"The name of the table"},{"displayName":"Primary Key Type","name":"primaryKey","type":"options","default":"id","options":[{"name":"Default","value":"id","description":"Default, added when table was created from UI by those options: Create new table / Import from Excel / Import from CSV"},{"name":"Imported From Airtable","value":"ncRecordId","description":"Select if table was imported from Airtable"},{"name":"Custom","value":"custom","description":"When connecting to existing external database as existing primary key field is retained as is, enter the name of the primary key field below"}],"displayOptions":{"show":{"operation":["delete","update"]}}},{"displayName":"Field Name","name":"customPrimaryKey","type":"string","default":"","displayOptions":{"show":{"operation":["delete","update"],"primaryKey":["custom"]}}},{"displayName":"Row ID Value","name":"id","type":"string","default":"","required":true,"description":"The value of the ID field","displayOptions":{"show":{"operation":["delete","get","update"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"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":{"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Download Attachments","name":"downloadAttachments","type":"boolean","displayOptions":{"show":{"operation":["getAll"]}},"default":false,"description":"Whether the attachment fields define in 'Download Fields' will be downloaded"},{"displayName":"Download Fields","name":"downloadFieldNames","type":"string","required":true,"displayOptions":{"show":{"operation":["getAll"],"downloadAttachments":[true]}},"default":"","description":"Name of the fields of type 'attachment' that should be downloaded. Multiple ones can be defined separated by comma. Case sensitive."},{"displayName":"Options","name":"options","type":"collection","displayOptions":{"show":{"operation":["getAll"]}},"default":{},"placeholder":"Add Option","options":[{"displayName":"Fields","name":"fields","type":"string","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Field"},"default":[],"placeholder":"Name","description":"The select fields of the returned rows"},{"displayName":"Filter By Formula","name":"where","type":"string","default":"","placeholder":"(name,like,example%)~or(name,eq,test)","description":"A formula used to filter rows"},{"displayName":"Sort","name":"sort","placeholder":"Add Sort Rule","description":"The sorting rules for the returned rows","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"property","displayName":"Property","values":[{"displayName":"Field","name":"field","type":"string","default":"","description":"Name of the field to sort on"},{"displayName":"Direction","name":"direction","type":"options","options":[{"name":"ASC","value":"asc","description":"Sort in ascending order (small -> large)"},{"name":"DESC","value":"desc","description":"Sort in descending order (large -> small)"}],"default":"asc","description":"The sort direction"}]}]}]},{"displayName":"Download Attachments","name":"downloadAttachments","type":"boolean","displayOptions":{"show":{"operation":["get"]}},"default":false,"description":"Whether the attachment fields define in 'Download Fields' will be downloaded"},{"displayName":"Download Fields","name":"downloadFieldNames","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"downloadAttachments":[true]}},"default":"","description":"Name of the fields of type 'attachment' that should be downloaded. Multiple ones can be defined separated by comma. Case sensitive."},{"displayName":"Data to Send","name":"dataToSend","type":"options","options":[{"name":"Auto-Map Input Data to Columns","value":"autoMapInputData","description":"Use when node input properties match destination column names"},{"name":"Define Below for Each Column","value":"defineBelow","description":"Set the value for each destination column"}],"displayOptions":{"show":{"operation":["create","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":{"operation":["create","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":{"operation":["create","update"],"dataToSend":["defineBelow"]}},"default":{},"options":[{"displayName":"Field","name":"fieldValues","values":[{"displayName":"Field Name","name":"fieldName","type":"string","default":""},{"displayName":"Is Binary Data","name":"binaryData","type":"boolean","default":false,"description":"Whether the field data to set is binary and should be taken from a binary property"},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","displayOptions":{"show":{"binaryData":[false]}}},{"displayName":"Take Input From Field","name":"binaryProperty","type":"string","description":"The field containing the binary file data to be uploaded","default":"","displayOptions":{"show":{"binaryData":[true]}}}]}]}]

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

credentials_required:
  [{"name":"nocoDb","required":true,"displayOptions":{"show":{"authentication":["nocoDb"]}}},{"name":"nocoDbApiToken","required":true,"displayOptions":{"show":{"authentication":["nocoDbApiToken"]}}}]


node_type: sendInBlue
package_name: n8n-nodes-base
display_name: Brevo
description: Consume Brevo API
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"sendInBlueApi","required":true}]
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Contact","value":"contact"},{"name":"Contact Attribute","value":"attribute"},{"name":"Email","value":"email"},{"name":"Sender","value":"sender"}],"default":"email"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["attribute"]}},"options":[{"name":"Create","value":"create","routing":{"request":{"method":"POST","url":"=/v3/contacts/attributes/{{$parameter.attributeCategory}}/{{encodeURI($parameter.attributeName)}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]},"send":{"preSend":[null]}},"action":"Create an attribute"},{"name":"Update","value":"update","routing":{"request":{"method":"PUT","url":"=/v3/contacts/attributes/{{$parameter.updateAttributeCategory}}/{{encodeURI($parameter.updateAttributeName)}}"}},"action":"Update an attribute"},{"name":"Delete","value":"delete","routing":{"request":{"method":"DELETE","url":"=/v3/contacts/attributes/{{$parameter.deleteAttributeCategory}}/{{encodeURI($parameter.deleteAttributeName)}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"action":"Delete an attribute"},{"name":"Get Many","value":"getAll","routing":{"request":{"method":"GET","url":"v3/contacts/attributes"},"send":{"paginate":false},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"attributes"}}]}},"action":"Get many attributes"}],"default":"create"},{"displayName":"Category","name":"attributeCategory","default":"normal","description":"Category of the attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["create"]}},"options":[{"name":"Calculated","value":"calculated"},{"name":"Category","value":"category"},{"name":"Global","value":"global"},{"name":"Normal","value":"normal"},{"name":"Transactional","value":"transactional"}],"type":"options","required":true},{"displayName":"Name","name":"attributeName","default":"","description":"Name of the attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["create"]}},"required":true,"type":"string"},{"displayName":"Type","name":"attributeType","default":"","description":"Attribute Type","displayOptions":{"show":{"resource":["attribute"],"operation":["create"],"attributeCategory":["normal"]}},"options":[{"name":"Boolean","value":"boolean"},{"name":"Date","value":"date"},{"name":"Float","value":"float"},{"name":"Text","value":"text"}],"required":true,"type":"options","routing":{"send":{"type":"body","property":"type","value":"={{$value}}"}}},{"displayName":"Value","name":"attributeValue","default":"","description":"Value of the attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["create"],"attributeCategory":["global","calculated"]}},"type":"string","placeholder":"","required":true,"routing":{"send":{"type":"body","property":"value","value":"={{$value}}"}}},{"displayName":"Contact Attribute List","name":"attributeCategoryList","type":"collection","placeholder":"Add Attributes","default":{},"displayOptions":{"show":{"resource":["attribute"],"operation":["create"],"attributeCategory":["category"]}},"options":[{"displayName":"Contact Attributes","name":"categoryEnumeration","placeholder":"Add Attribute","type":"fixedCollection","typeOptions":{"multipleValues":true},"options":[{"name":"attributesValues","displayName":"Attribute","values":[{"displayName":"Value ID","name":"attributeCategoryValue","type":"number","default":1,"description":"ID of the value, must be numeric","routing":{"send":{"value":"={{$value}}","property":"=enumeration[{{$index}}].value","type":"body"}}},{"displayName":"Label","name":"attributeCategoryLabel","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=enumeration[{{$index}}].label","type":"body"}},"description":"Label of the value"}]}],"default":{},"description":"List of values and labels that the attribute can take"}]},{"displayName":"Category","name":"updateAttributeCategory","default":"calculated","description":"Category of the attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["update"]}},"options":[{"name":"Calculated","value":"calculated"},{"name":"Category","value":"category"},{"name":"Global","value":"global"}],"type":"options"},{"displayName":"Name","name":"updateAttributeName","default":"","description":"Name of the existing attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["update"]}},"type":"string"},{"displayName":"Value","name":"updateAttributeValue","default":"","description":"Value of the attribute to update","displayOptions":{"show":{"resource":["attribute"],"operation":["update"]},"hide":{"updateAttributeCategory":["category"]}},"type":"string","placeholder":"","routing":{"send":{"type":"body","property":"value","value":"={{$value}}"}}},{"displayName":"Update Fields","name":"updateAttributeCategoryList","default":{},"description":"List of the values and labels that the attribute can take","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["attribute"],"operation":["update"],"updateAttributeCategory":["category"]}},"options":[{"displayName":"Contact Attributes","name":"updateCategoryEnumeration","placeholder":"Add Attribute","type":"fixedCollection","typeOptions":{"multipleValues":true},"options":[{"name":"updateAttributesValues","displayName":"Attribute","values":[{"displayName":"Value","name":"attributeCategoryValue","type":"number","default":1,"description":"ID of the value, must be numeric","routing":{"send":{"value":"={{$value}}","property":"=enumeration[{{$index}}].value","type":"body"}}},{"displayName":"Label","name":"attributeCategoryLabel","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=enumeration[{{$index}}].label","type":"body"}},"description":"Label of the value"}]}],"default":{},"description":"List of values and labels that the attribute can take"}]},{"displayName":"Category","name":"deleteAttributeCategory","default":"normal","description":"Category of the attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["delete"]}},"options":[{"name":"Calculated","value":"calculated"},{"name":"Category","value":"category"},{"name":"Global","value":"global"},{"name":"Normal","value":"normal"},{"name":"Transactional","value":"transactional"}],"type":"options"},{"displayName":"Name","name":"deleteAttributeName","default":"","description":"Name of the attribute","displayOptions":{"show":{"resource":["attribute"],"operation":["delete"]}},"type":"string"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["attribute"],"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":["attribute"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"routing":{"output":{"postReceive":[{"type":"limit","properties":{"maxResults":"={{$value}}"}}]}},"default":50,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["sender"]}},"options":[{"name":"Create","value":"create","action":"Create a sender"},{"name":"Delete","value":"delete","routing":{"request":{"method":"DELETE","url":"=/v3/senders/{{$parameter.id}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"action":"Delete a sender"},{"name":"Get Many","value":"getAll","routing":{"request":{"method":"GET","url":"/v3/senders"},"send":{"paginate":false},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"senders"}}]}},"action":"Get many senders"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","default":"","displayOptions":{"show":{"resource":["sender"],"operation":["create"]}},"routing":{"request":{"method":"POST","url":"/v3/senders"},"send":{"property":"name","type":"body"}},"required":true,"description":"Name of the sender"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","displayOptions":{"show":{"resource":["sender"],"operation":["create"]}},"routing":{"send":{"property":"email","type":"body"}},"required":true,"description":"Email of the sender"},{"displayName":"Sender ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["sender"],"operation":["delete"]}},"description":"ID of the sender to delete"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["sender"],"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":["sender"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"routing":{"output":{"postReceive":[{"type":"limit","properties":{"maxResults":"={{$value}}"}}]}},"default":10,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"options":[{"name":"Create","value":"create","action":"Create a contact","routing":{"request":{"method":"POST","url":"/v3/contacts"}}},{"name":"Create or Update","value":"upsert","action":"Upsert a contact","routing":{"request":{"method":"POST","url":"=/v3/contacts"}}},{"name":"Delete","value":"delete","action":"Delete a contact"},{"name":"Get","value":"get","action":"Get a contact"},{"name":"Get Many","value":"getAll","routing":{"request":{"method":"GET","url":"/v3/contacts"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"contacts"}}]},"operations":{"pagination":{"type":"offset","properties":{"limitParameter":"limit","offsetParameter":"offset","pageSize":1000,"type":"query"}}}},"action":"Get many contacts"},{"name":"Update","value":"update","routing":{"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"action":"Update a contact"}],"default":"create"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"default":"","routing":{"send":{"type":"body","property":"email"}}},{"displayName":"Contact Attributes","name":"createContactAttributes","default":{},"description":"Array of attributes to be added","displayOptions":{"show":{"resource":["contact"],"operation":["create"]}},"options":[{"name":"attributesValues","displayName":"Attribute","values":[{"displayName":"Field Name","name":"fieldName","type":"options","typeOptions":{"loadOptions":{"routing":{"request":{"method":"GET","url":"/v3/contacts/attributes"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"attributes"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}} - ({{$responseItem.category}})","value":"={{$responseItem.name}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"default":""},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=attributes.{{$parent.fieldName}}","type":"body"}}}]}],"placeholder":"Add Attribute","type":"fixedCollection","typeOptions":{"multipleValues":true}},{"displayName":"Return All","name":"returnAll","type":"boolean","routing":{"send":{"paginate":"={{$value}}"}},"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"],"returnAll":[false]}},"routing":{"send":{"type":"query","property":"limit"}},"typeOptions":{"minValue":1,"maxValue":1000},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":{},"options":[{"displayName":"Sort","name":"sort","type":"options","options":[{"name":"DESC","value":"desc"},{"name":"ASC","value":"asc"}],"routing":{"send":{"type":"query","property":"sort","value":"={{$value}}"}},"default":"desc","description":"Sort the results in the ascending/descending order of record creation"}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":{},"options":[{"displayName":"Modified Since","name":"modifiedSince","type":"dateTime","routing":{"send":{"type":"query","property":"modifiedSince"}},"default":"","description":"Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)"}]},{"displayName":"Contact Identifier","name":"identifier","type":"string","displayOptions":{"show":{"resource":["contact"],"operation":["get"]}},"routing":{"request":{"method":"GET","url":"=/v3/contacts/{{encodeURIComponent($value)}}"}},"required":true,"default":"","description":"Email (urlencoded) OR ID of the contact OR its SMS attribute value"},{"displayName":"Contact Identifier","name":"identifier","type":"string","displayOptions":{"show":{"resource":["contact"],"operation":["delete"]}},"routing":{"request":{"method":"DELETE","url":"=/v3/contacts/{{encodeURIComponent($parameter.identifier)}}"},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}},"default":"","description":"Email (urlencoded) OR ID of the contact OR its SMS attribute value"},{"displayName":"Contact Identifier","name":"identifier","default":"","description":"Email (urlencoded) OR ID of the contact OR its SMS attribute value","displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"type":"string","required":true},{"displayName":"Attributes","name":"updateAttributes","default":{},"description":"Array of attributes to be updated","displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"options":[{"displayName":"Attribute","name":"updateAttributesValues","values":[{"displayName":"Field Name","name":"fieldName","type":"options","typeOptions":{"loadOptions":{"routing":{"request":{"method":"GET","url":"/v3/contacts/attributes"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"attributes"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}} - ({{$responseItem.category}})","value":"={{$responseItem.name}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"default":""},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=attributes.{{$parent.fieldName}}","type":"body"}}}]}],"placeholder":"Add Attribute","routing":{"request":{"method":"PUT","url":"=/v3/contacts/{{encodeURIComponent($parameter.identifier)}}"}},"type":"fixedCollection","typeOptions":{"multipleValues":true}},{"displayName":"Email","name":"email","default":"","description":"Email of the contact","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"type":"string","placeholder":"name@email.com","required":true,"routing":{"send":{"value":"={{$value}}","property":"email","type":"body"}}},{"displayName":"Contact Attributes","name":"upsertAttributes","default":{},"description":"Array of attributes to be updated","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"options":[{"name":"upsertAttributesValues","displayName":"Attribute","values":[{"displayName":"Field Name","name":"fieldName","type":"options","typeOptions":{"loadOptions":{"routing":{"request":{"method":"GET","url":"/v3/contacts/attributes"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"attributes"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}} - ({{$responseItem.category}})","value":"={{$responseItem.name}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"default":""},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","routing":{"send":{"value":"={{$value}}","property":"=attributes.{{$parent.fieldName}}","type":"body"}}}]}],"placeholder":"Add Attribute","type":"fixedCollection","typeOptions":{"multipleValues":true},"routing":{"send":{"preSend":[null]},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"success\": true } }}"}}]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["email"]}},"options":[{"name":"Send","value":"send","action":"Send a transactional email"},{"name":"Send Template","value":"sendTemplate","action":"Send an email with an existing Template"}],"routing":{"request":{"method":"POST","url":"/v3/smtp/email"}},"default":"send"},{"displayName":"Send HTML","name":"sendHTML","type":"boolean","displayOptions":{"show":{"resource":["email"],"operation":["send"]}},"default":false},{"displayName":"Subject","name":"subject","type":"string","displayOptions":{"show":{"resource":["email"],"operation":["send"]}},"routing":{"send":{"property":"subject","type":"body"}},"default":"","description":"Subject of the email"},{"displayName":"Text Content","name":"textContent","type":"string","displayOptions":{"show":{"resource":["email"],"operation":["send"],"sendHTML":[false]}},"routing":{"send":{"property":"textContent","type":"body"}},"default":"","description":"Text content of the message"},{"displayName":"HTML Content","name":"htmlContent","type":"string","displayOptions":{"show":{"resource":["email"],"operation":["send"],"sendHTML":[true]}},"routing":{"send":{"property":"htmlContent","type":"body"}},"default":"","description":"HTML content of the message"},{"displayName":"Sender","name":"sender","type":"string","displayOptions":{"show":{"resource":["email"],"operation":["send"]}},"default":"","required":true,"routing":{"send":{"preSend":[null]}}},{"displayName":"Receipients","name":"receipients","type":"string","displayOptions":{"show":{"resource":["email"],"operation":["send"]}},"default":"","required":true,"routing":{"send":{"preSend":[null]}}},{"displayName":"Additional Fields","name":"additionalFields","placeholder":"Add Field","description":"Additional fields to add","type":"collection","default":{},"displayOptions":{"show":{"resource":["email"],"operation":["send"]}},"options":[{"displayName":"Attachments","name":"emailAttachments","placeholder":"Add Attachment","type":"fixedCollection","default":{},"options":[{"name":"attachment","displayName":"Attachment Data","values":[{"displayName":"Input Data Field Name","default":"","name":"binaryPropertyName","type":"string","description":"The name of the incoming field containing the binary file data to be processed"}]}],"routing":{"send":{"preSend":[null]}}},{"displayName":"Receipients BCC","name":"receipientsBCC","placeholder":"Add BCC","type":"fixedCollection","default":{},"options":[{"name":"receipientBcc","displayName":"Receipient","values":[{"displayName":"Receipient","name":"bcc","type":"string","default":""}]}],"routing":{"send":{"preSend":[null]}}},{"displayName":"Receipients CC","name":"receipientsCC","placeholder":"Add CC","type":"fixedCollection","default":{},"options":[{"name":"receipientCc","displayName":"Receipient","values":[{"displayName":"Receipient","name":"cc","type":"string","default":""}]}],"routing":{"send":{"preSend":[null]}}},{"displayName":"Email Tags","name":"emailTags","default":{},"description":"Add tags to your emails to find them more easily","placeholder":"Add Email Tags","type":"fixedCollection","options":[{"displayName":"Tags","name":"tags","values":[{"displayName":"Tag","default":"","name":"tag","type":"string"}]}],"routing":{"send":{"preSend":[null]}}}]},{"displayName":"Template ID","name":"templateId","type":"options","default":"","typeOptions":{"loadOptions":{"routing":{"request":{"method":"GET","url":"/v3/smtp/templates","qs":{"templateStatus":true,"limit":1000,"offset":0,"sort":"desc"}},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"templates"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"displayOptions":{"show":{"resource":["email"],"operation":["sendTemplate"]}},"routing":{"send":{"type":"body","property":"templateId"}}},{"displayName":"Receipients","name":"receipients","type":"string","displayOptions":{"show":{"resource":["email"],"operation":["sendTemplate"]}},"default":"","required":true,"routing":{"send":{"preSend":[null]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","description":"Additional fields to add","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["email"],"operation":["sendTemplate"]}},"options":[{"displayName":"Attachments","name":"emailAttachments","placeholder":"Add Attachment","type":"fixedCollection","default":{},"options":[{"displayName":"Attachment Data","name":"attachment","values":[{"displayName":"Input Data Field Name","name":"binaryPropertyName","default":"","type":"string","description":"The name of the incoming field containing the binary file data to be processed"}]}],"routing":{"send":{"preSend":[null]}}},{"displayName":"Email Tags","name":"emailTags","default":{},"description":"Add tags to your emails to find them more easily","placeholder":"Add Email Tags","type":"fixedCollection","options":[{"displayName":"Tags","name":"tags","values":[{"displayName":"Tag","default":"","name":"tag","type":"string"}]}],"routing":{"send":{"preSend":[null]}}},{"displayName":"Template Parameters","name":"templateParameters","default":{},"description":"Pass a set of attributes to customize the template","placeholder":"Add Parameter","type":"fixedCollection","options":[{"name":"parameterValues","displayName":"Parameters","values":[{"displayName":"Parameter","name":"parameters","type":"string","default":"","placeholder":"key=value","description":"Comma-separated key=value pairs"}]}],"routing":{"send":{"preSend":[null]}}}]}]

operations:
  [{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"attribute","name":"Contact Attribute"},{"type":"resource","resource":"email","name":"Email"},{"type":"resource","resource":"sender","name":"Sender"},{"type":"operation","operation":"create","name":"Create","action":"Create an attribute","resources":["attribute"]},{"type":"operation","operation":"update","name":"Update","action":"Update an attribute","resources":["attribute"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an attribute","resources":["attribute"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many attributes","resources":["attribute"]},{"type":"operation","operation":"create","name":"Create","action":"Create a sender","resources":["sender"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a sender","resources":["sender"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many senders","resources":["sender"]},{"type":"operation","operation":"create","name":"Create","action":"Create a contact","resources":["contact"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Upsert a contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact","resources":["contact"]},{"type":"operation","operation":"send","name":"Send","action":"Send a transactional email","resources":["email"]},{"type":"operation","operation":"sendTemplate","name":"Send Template","action":"Send an email with an existing Template","resources":["email"]}]


node_type: sendInBlueTrigger
package_name: n8n-nodes-base
display_name: Brevo Trigger
description: Starts the workflow when Brevo events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"sendInBlueApi","required":true}]
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Resource","default":"transactional","name":"type","options":[{"name":"Inbound","value":"inbound"},{"name":"Marketing","value":"marketing"},{"name":"Transactional","value":"transactional"}],"required":true,"type":"options"},{"displayName":"Trigger On","displayOptions":{"show":{"type":["transactional"]}},"name":"events","placeholder":"Add Event","options":[{"name":"Email Blocked","value":"blocked","description":"Triggers when transactional email is blocked"},{"name":"Email Clicked","value":"click","description":"Triggers when transactional email is clicked"},{"name":"Email Deferred","value":"deferred","description":"Triggers when transactional email is deferred"},{"name":"Email Delivered","value":"delivered","description":"Triggers when transactional email is delivered"},{"name":"Email Hard Bounce","value":"hardBounce","description":"Triggers when transactional email is hard bounced"},{"name":"Email Invalid","value":"invalid","description":"Triggers when transactional email is invalid"},{"name":"Email Marked Spam","value":"spam","description":"Triggers when transactional email is set to spam"},{"name":"Email Opened","value":"opened","description":"Triggers when transactional email is opened"},{"name":"Email Sent","value":"request","description":"Triggers when transactional email is sent"},{"name":"Email Soft-Bounce","value":"softBounce","description":"Triggers when transactional email is soft bounced"},{"name":"Email Unique Open","value":"uniqueOpened","description":"Triggers when transactional email is unique opened"},{"name":"Email Unsubscribed","value":"unsubscribed","description":"Triggers when transactional email is unsubscribed"}],"default":[],"required":true,"type":"multiOptions"},{"displayName":"Trigger On","displayOptions":{"show":{"type":["marketing"]}},"name":"events","placeholder":"Add Event","options":[{"name":"Marketing Email Clicked","value":"click","description":"Triggers when marketing email is clicked"},{"name":"Marketing Email Delivered","value":"delivered","description":"Triggers when marketing email is delivered"},{"name":"Marketing Email Hard Bounce","value":"hardBounce","description":"Triggers when marketing email is hard bounced"},{"name":"Marketing Email List Addition","value":"listAddition","description":"Triggers when marketing email is clicked"},{"name":"Marketing Email Opened","value":"opened","description":"Triggers when marketing email is opened"},{"name":"Marketing Email Soft Bounce","value":"softBounce","description":"Triggers when marketing email is soft bounced"},{"name":"Marketing Email Spam","value":"spam","description":"Triggers when marketing email is spam"},{"name":"Marketing Email Unsubscribed","value":"unsubscribed","description":"Triggers when marketing email is unsubscribed"}],"default":[],"required":true,"type":"multiOptions"},{"displayName":"Trigger On","displayOptions":{"show":{"type":["inbound"]}},"name":"events","placeholder":"Add Event","options":[{"name":"Inbound Email Processed","value":"inboundEmailProcessed","description":"Triggers when inbound email is processed"}],"default":[],"required":true,"type":"multiOptions"}]


node_type: stickyNote
package_name: n8n-nodes-base
display_name: Sticky Note
description: Make your workflow easier to understand
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Content","name":"content","type":"string","required":true,"default":"## I'm a note \n**Double click** to edit me. [Guide](https://docs.n8n.io/workflows/sticky-notes/)"},{"displayName":"Height","name":"height","type":"number","required":true,"default":160},{"displayName":"Width","name":"width","type":"number","required":true,"default":240}]


node_type: noOp
package_name: n8n-nodes-base
display_name: No Operation, do nothing
description: No Operation
category: organization
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: No Operation, do nothing
  description: Documentation for the No Operation, do nothing node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # No Operation, do nothing

  Use the No Operation, do nothing node when you don't want to perform any operations. The purpose of this node is to make the workflow easier to read and understand where the flow of data stops. This can help others visually get a better understanding of the workflow.

  ## Templates and examples

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


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

  # Onfleet node

  Use the Onfleet node to automate work in Onfleet, and integrate Onfleet with other applications. n8n has built-in support for a wide range of Onfleet features, including creating and deleting tasks in Onfleet as well as retrieving organizations' details. 

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

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

  ## Operations

  * Admin
      * Create a new Onfleet admin
      * Delete an Onfleet admin
      * Get all Onfleet admins
      * Update an Onfleet admin
  * Container
      * Add task at index (or append)
      * Get container information
      * Fully replace a container's tasks
  * Destination
      * Create a new destination
      * Get a specific destination
  * Hub
      * Create a new Onfleet hub
      * Get all Onfleet hubs
      * Update an Onfleet hub
  * Organization
      * Retrieve your own organization's details
      * Retrieve the details of an organization with which you are connected
  * Recipient
      * Create a new Onfleet recipient
      * Get a specific Onfleet recipient
      * Update an Onfleet recipient
  * Task
      * Create a new Onfleet task
      * Clone an Onfleet task
      * Force-complete a started Onfleet task
      * Delete an Onfleet task
      * Get all Onfleet tasks
      * Get a specific Onfleet task
      * Update an Onfleet task
  * Team
      * Automatically dispatch tasks assigned to a team to on-duty drivers
      * Create a new Onfleet team
      * Delete an Onfleet team
      * Get a specific Onfleet team
      * Get all Onfleet teams
      * Get estimated times for upcoming tasks for a team, returns a selected driver
      * Update an Onfleet team
  * Worker
      * Create a new Onfleet worker
      * Delete an Onfleet worker
      * Get a specific Onfleet worker
      * Get all Onfleet workers
      * Get a specific Onfleet worker schedule
      * Update an Onfleet worker

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Admin","value":"admin"},{"name":"Container","value":"container"},{"name":"Destination","value":"destination"},{"name":"Hub","value":"hub"},{"name":"Organization","value":"organization"},{"name":"Recipient","value":"recipient"},{"name":"Task","value":"task"},{"name":"Team","value":"team"},{"name":"Worker","value":"worker"}],"default":"task","description":"The resource to perform operations on"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["admin"]}},"options":[{"name":"Create","value":"create","description":"Create a new Onfleet admin","action":"Create an admin"},{"name":"Delete","value":"delete","description":"Delete an Onfleet admin","action":"Delete an admin"},{"name":"Get Many","value":"getAll","description":"Get many Onfleet admins","action":"Get many admins"},{"name":"Update","value":"update","description":"Update an Onfleet admin","action":"Update an admin"}],"default":"getAll"},{"displayName":"Admin ID","name":"id","type":"string","displayOptions":{"show":{"resource":["admin"]},"hide":{"operation":["create","getAll"]}},"default":"","required":true,"description":"The ID of the admin object for lookup"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["admin"],"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":["admin"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":64},"default":64,"description":"Max number of results to return"},{"displayOptions":{"show":{"resource":["admin"],"operation":["create"]}},"required":true,"displayName":"Name","name":"name","type":"string","default":"","description":"The administrator's name"},{"displayOptions":{"show":{"resource":["admin"],"operation":["create"]}},"required":true,"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The administrator's email address"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["admin"],"operation":["create"]}},"options":[{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The administrator's phone number"},{"displayName":"Read Only","name":"isReadOnly","type":"boolean","default":false,"description":"Whether this administrator can perform write operations"}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["admin"],"operation":["update"]}},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"The administrator's name"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"The administrator's phone number"},{"displayName":"Read Only","name":"isReadOnly","type":"boolean","default":false,"description":"Whether this administrator can perform write operations"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["container"]}},"options":[{"name":"Add Tasks","value":"addTask","description":"Add task at index (or append)","action":"Add tasks"},{"name":"Get","value":"get","description":"Get container information","action":"Get a container"},{"name":"Update Tasks","value":"updateTask","description":"Fully replace a container's tasks","action":"Update tasks"}],"default":"get"},{"displayName":"Container Type","name":"containerType","type":"options","options":[{"name":"Organizations","value":"organizations"},{"name":"Teams","value":"teams"},{"name":"Workers","value":"workers"}],"default":"","displayOptions":{"show":{"resource":["container"],"operation":["get","addTask"]}},"required":true},{"displayName":"Container ID","name":"containerId","type":"string","default":"","description":"The object ID according to the container chosen","displayOptions":{"show":{"resource":["container"],"operation":["get","addTask","updateTask"]}},"required":true},{"displayName":"Insert Type","name":"type","type":"options","options":[{"name":"Append","value":-1},{"name":"Prepend","value":0},{"name":"At Specific Index","value":1}],"default":"","displayOptions":{"show":{"resource":["container"],"operation":["addTask"]}},"required":true},{"displayName":"Index","name":"index","type":"number","default":0,"description":"The index given indicates the position where the tasks are going to be inserted","displayOptions":{"show":{"resource":["container"],"operation":["addTask"],"type":[1]}},"required":true},{"displayName":"Task IDs","name":"tasks","type":"string","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Task"},"default":[],"description":"Task's ID that are going to be used","displayOptions":{"show":{"resource":["container"],"operation":["addTask","updateTask"]}},"required":true},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["container"],"operation":["addTask","updateTask"]}},"options":[{"displayName":"Consider Dependencies","name":"considerDependencies","type":"boolean","default":false,"description":"Whether to include the target task's dependency family (parent and child tasks) in the resulting assignment operation","required":false}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["destination"]}},"options":[{"name":"Create","value":"create","description":"Create a new destination","action":"Create a destination"},{"name":"Get","value":"get","description":"Get a specific destination","action":"Get a destination"}],"default":"get"},{"displayName":"Destination ID","name":"id","type":"string","displayOptions":{"show":{"resource":["destination"]},"hide":{"operation":["create"]}},"default":"","required":true,"description":"The ID of the destination object for lookup"},{"displayName":"Unparsed Address","name":"unparsed","type":"boolean","description":"Whether or not the address is specified in a single unparsed string","default":false,"displayOptions":{"show":{"resource":["destination"],"operation":["create"]}},"required":true},{"displayName":"Destination Address","name":"address","type":"string","description":"The destination's street address details","default":"","displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[true]}},"required":true},{"displayName":"Number","name":"addressNumber","type":"string","description":"The number component of this address, it may also contain letters","default":"","displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[false]}},"required":true},{"displayName":"Street","name":"addressStreet","type":"string","description":"The name of the street","default":"","displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[false]}},"required":true},{"displayName":"City","name":"addressCity","type":"string","description":"The name of the municipality","default":"","displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[false]}},"required":true},{"displayName":"Country","name":"addressCountry","type":"string","description":"The name of the country","default":"","displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[false]}},"required":true},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[true]}},"options":[{"displayName":"Apartment","name":"addressApartment","type":"string","default":"","description":"The suite or apartment number, or any additional relevant information"},{"displayName":"Address Name","name":"addressName","type":"string","default":"","description":"A name associated with this address"},{"displayName":"Address Notes","name":"addressNotes","type":"string","default":"","description":"Notes about the destination"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["destination"],"operation":["create"],"unparsed":[false]}},"options":[{"displayName":"Apartment","name":"addressApartment","type":"string","default":"","description":"The suite or apartment number, or any additional relevant information"},{"displayName":"Address Name","name":"addressName","type":"string","default":"","description":"A name associated with this address"},{"displayName":"Address Notes","name":"addressNotes","type":"string","default":"","description":"Notes about the destination"},{"displayName":"Postal Code","name":"addressPostalCode","type":"string","default":"","description":"The postal or zip code"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["hub"]}},"options":[{"name":"Create","value":"create","description":"Create a new Onfleet hub","action":"Create a hub"},{"name":"Get Many","value":"getAll","description":"Get many Onfleet hubs","action":"Get many hubs"},{"name":"Update","value":"update","description":"Update an Onfleet hub","action":"Update a hub"}],"default":"getAll"},{"displayName":"Hub ID","name":"id","type":"string","displayOptions":{"show":{"resource":["hub"],"operation":["update"]}},"default":"","required":true,"description":"The ID of the hub object for lookup"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["hub"],"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":["hub"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":64},"default":64,"description":"Max number of results to return"},{"displayName":"Name","name":"name","type":"string","default":"","description":"A name to identify the hub","displayOptions":{"show":{"resource":["hub"],"operation":["create"]}},"required":true},{"displayName":"Destination","name":"destination","type":"fixedCollection","placeholder":"Add Destination","default":{},"options":[{"displayName":"Destination Properties","name":"destinationProperties","default":{},"values":[{"displayName":"Unparsed Address","name":"unparsed","type":"boolean","description":"Whether or not the address is specified in a single unparsed string","default":false,"required":false},{"displayName":"Destination Address","name":"address","type":"string","description":"The destination's street address details","default":"","displayOptions":{"show":{"unparsed":[true]}},"required":true},{"displayName":"Number","name":"addressNumber","type":"string","description":"The number component of this address, it may also contain letters","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"Street","name":"addressStreet","type":"string","description":"The name of the street","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"City","name":"addressCity","type":"string","description":"The name of the municipality","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"State","name":"addressState","type":"string","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"Country","name":"addressCountry","type":"string","description":"The name of the country","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayOptions":{"show":{"unparsed":[false]}},"displayName":"Postal Code","name":"addressPostalCode","type":"string","default":"","description":"The postal or zip code","required":false},{"displayName":"Address Name","name":"addressName","type":"string","default":"","description":"A name associated with this address","required":false},{"displayName":"Apartment","name":"addressApartment","type":"string","default":"","description":"The suite or apartment number, or any additional relevant information","required":false},{"displayName":"Address Notes","name":"addressNotes","type":"string","default":"","description":"Notes about the destination","required":false}]}],"displayOptions":{"show":{"resource":["hub"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["hub"],"operation":["create"]}},"options":[{"displayName":"Team Names or IDs","name":"teams","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTeams"},"default":[],"description":"These are the teams that this Hub will be assigned to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","required":false}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["hub"],"operation":["update"]}},"options":[{"displayName":"Destination","name":"destination","type":"fixedCollection","placeholder":"Add Destination","default":{},"options":[{"displayName":"Destination Properties","name":"destinationProperties","default":{},"values":[{"displayName":"Unparsed Address","name":"unparsed","type":"boolean","description":"Whether or not the address is specified in a single unparsed string","default":false,"required":false},{"displayName":"Destination Address","name":"address","type":"string","description":"The destination's street address details","default":"","displayOptions":{"show":{"unparsed":[true]}},"required":true},{"displayName":"Number","name":"addressNumber","type":"string","description":"The number component of this address, it may also contain letters","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"Street","name":"addressStreet","type":"string","description":"The name of the street","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"City","name":"addressCity","type":"string","description":"The name of the municipality","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"State","name":"addressState","type":"string","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"Country","name":"addressCountry","type":"string","description":"The name of the country","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayOptions":{"show":{"unparsed":[false]}},"displayName":"Postal Code","name":"addressPostalCode","type":"string","default":"","description":"The postal or zip code","required":false},{"displayName":"Address Name","name":"addressName","type":"string","default":"","description":"A name associated with this address","required":false},{"displayName":"Apartment","name":"addressApartment","type":"string","default":"","description":"The suite or apartment number, or any additional relevant information","required":false},{"displayName":"Address Notes","name":"addressNotes","type":"string","default":"","description":"Notes about the destination","required":false}]}],"required":false},{"displayName":"Name","name":"name","type":"string","default":"","description":"A name to identify the hub"},{"displayName":"Team Names or IDs","name":"teams","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTeams"},"default":[],"description":"These are the teams that this Hub will be assigned to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","required":false}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["organization"]}},"options":[{"name":"Get My Organization","value":"get","description":"Retrieve your own organization's details","action":"Get my organization"},{"name":"Get Delegatee Details","value":"getDelegatee","description":"Retrieve the details of an organization with which you are connected","action":"Get a delegatee's details"}],"default":"get"},{"displayName":"Organization ID","name":"id","type":"string","displayOptions":{"show":{"resource":["organization"],"operation":["getDelegatee"]}},"default":"","required":true,"description":"The ID of the delegatees for lookup"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["recipient"]}},"options":[{"name":"Create","value":"create","description":"Create a new Onfleet recipient","action":"Create a recipient"},{"name":"Get","value":"get","description":"Get a specific Onfleet recipient","action":"Get a recipient"},{"name":"Update","value":"update","description":"Update an Onfleet recipient","action":"Update a recipient"}],"default":"get"},{"displayName":"Get By","name":"getBy","type":"options","displayOptions":{"show":{"resource":["recipient"],"operation":["get"]}},"options":[{"name":"ID","value":"id"},{"name":"Phone","value":"phone"},{"name":"Name","value":"name"}],"description":"The variable that is used for looking up a recipient","required":true,"default":"id"},{"displayName":"Recipient ID","name":"id","type":"string","displayOptions":{"show":{"resource":["recipient"],"operation":["get"],"getBy":["id"]}},"default":"","required":true,"description":"The ID of the recipient object for lookup"},{"displayName":"Recipient ID","name":"id","type":"string","displayOptions":{"show":{"resource":["recipient"],"operation":["update"]}},"default":"","required":true,"description":"The ID of the recipient object for lookup"},{"displayName":"Name","name":"name","type":"string","displayOptions":{"show":{"resource":["recipient"],"operation":["get"],"getBy":["name"]}},"default":"","required":true,"description":"The name of the recipient for lookup"},{"displayName":"Phone","name":"phone","type":"string","displayOptions":{"show":{"resource":["recipient"],"operation":["get"],"getBy":["phone"]}},"default":"","required":true,"description":"The phone of the recipient for lookup"},{"displayOptions":{"show":{"resource":["recipient"],"operation":["create"]}},"displayName":"Recipient Name","name":"recipientName","type":"string","description":"The recipient's complete name","default":"","required":true},{"displayOptions":{"show":{"resource":["recipient"],"operation":["create"]}},"displayName":"Recipient Phone","name":"recipientPhone","type":"string","description":"A unique, valid phone number as per the organization's country if there's no leading + sign. If a phone number has a leading + sign, it will disregard the organization's country setting.","default":"","required":true},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["recipient"],"operation":["create"]}},"options":[{"displayName":"Recipient Notes","name":"recipientNotes","type":"string","default":"","description":"Notes for this recipient: these are global notes that should not be task- or destination-specific"},{"displayName":"Skip Recipient SMS Notifications","name":"recipientSkipSMSNotifications","type":"boolean","default":false,"description":"Whether this recipient has requested to skip SMS notifications"}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Update Fields","default":{},"displayOptions":{"show":{"resource":["recipient"],"operation":["update"]}},"options":[{"displayName":"Recipient Name","name":"recipientName","type":"string","description":"The recipient's complete name","default":"","required":false},{"displayName":"Recipient Notes","name":"notes","type":"string","default":"","description":"Notes for this recipient: these are global notes that should not be task- or destination-specific"},{"displayName":"Recipient Phone","name":"recipientPhone","type":"string","description":"A unique, valid phone number as per the organization's country if there's no leading + sign. If a phone number has a leading + sign, it will disregard the organization's country setting.","default":"","required":false},{"displayName":"Skip Recipient SMS Notifications","name":"skipSMSNotifications","type":"boolean","default":false,"description":"Whether this recipient has requested to skip SMS notifications"}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["recipient"],"operation":["create"]}},"options":[{"displayName":"Skip Recipient Phone Number Validation","name":"recipientSkipPhoneNumberValidation","type":"boolean","default":false,"description":"Whether to skip validation for this recipient's phone number"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["task"]}},"options":[{"name":"Clone","value":"clone","description":"Clone an Onfleet task","action":"Clone a task"},{"name":"Complete","value":"complete","description":"Force-complete a started Onfleet task","action":"Complete a task"},{"name":"Create","value":"create","description":"Create a new Onfleet task","action":"Create a task"},{"name":"Delete","value":"delete","description":"Delete an Onfleet task","action":"Delete a task"},{"name":"Get","value":"get","description":"Get a specific Onfleet task","action":"Get a task"},{"name":"Get Many","value":"getAll","description":"Get many Onfleet tasks","action":"Get many tasks"},{"name":"Update","value":"update","description":"Update an Onfleet task","action":"Update a task"}],"default":"get"},{"displayName":"Task ID","name":"id","type":"string","displayOptions":{"show":{"resource":["task"]},"hide":{"operation":["create","getAll"]}},"default":"","required":true,"description":"The ID of the task object for lookup"},{"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":64},"default":64,"description":"Max number of results to return"},{"displayName":"Destination","name":"destination","type":"fixedCollection","placeholder":"Add Destination","default":{},"options":[{"displayName":"Destination Properties","name":"destinationProperties","default":{},"values":[{"displayName":"Unparsed Address","name":"unparsed","type":"boolean","description":"Whether or not the address is specified in a single unparsed string","default":false,"required":false},{"displayName":"Destination Address","name":"address","type":"string","description":"The destination's street address details","default":"","displayOptions":{"show":{"unparsed":[true]}},"required":true},{"displayName":"Number","name":"addressNumber","type":"string","description":"The number component of this address, it may also contain letters","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"Street","name":"addressStreet","type":"string","description":"The name of the street","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"City","name":"addressCity","type":"string","description":"The name of the municipality","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"State","name":"addressState","type":"string","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayName":"Country","name":"addressCountry","type":"string","description":"The name of the country","default":"","displayOptions":{"show":{"unparsed":[false]}},"required":true},{"displayOptions":{"show":{"unparsed":[false]}},"displayName":"Postal Code","name":"addressPostalCode","type":"string","default":"","description":"The postal or zip code","required":false},{"displayName":"Address Name","name":"addressName","type":"string","default":"","description":"A name associated with this address","required":false},{"displayName":"Apartment","name":"addressApartment","type":"string","default":"","description":"The suite or apartment number, or any additional relevant information","required":false},{"displayName":"Address Notes","name":"addressNotes","type":"string","default":"","description":"Notes about the destination","required":false}]}],"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"required":true},{"displayName":"Complete as a Success","name":"success","type":"boolean","displayOptions":{"show":{"resource":["task"],"operation":["complete"]}},"description":"Whether the task's completion was successful","required":true,"default":true},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"options":[{"displayName":"From","name":"from","type":"dateTime","default":"","description":"The starting time of the range. Tasks created or completed at or after this time will be included."},{"displayName":"State","name":"state","type":"multiOptions","options":[{"name":"[All]","value":"all"},{"name":"Active","value":2},{"name":"Assigned","value":1},{"name":"Completed","value":3},{"name":"Unassigned","value":0}],"default":["all"],"description":"The state of the tasks"},{"displayName":"To","name":"to","type":"dateTime","default":"","description":"The ending time of the range. Defaults to current time if not specified."}]},{"displayName":"Override Fields","name":"overrideFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["clone"]}},"options":[{"displayName":"Complete After","name":"completeAfter","type":"dateTime","default":null,"description":"The earliest time the task should be completed"},{"displayName":"Complete Before","name":"completeBefore","type":"dateTime","default":null,"description":"The latest time the task should be completed"},{"displayName":"Include Barcodes","name":"includeBarcodes","type":"boolean","default":false},{"displayName":"Include Dependencies","name":"includeDependencies","type":"boolean","default":false},{"displayName":"Include Metadata","name":"includeMetadata","type":"boolean","default":false},{"displayName":"Notes","name":"notes","type":"string","default":"","description":"Notes for the task","required":false},{"displayName":"Pick Up Task","name":"pickupTask","type":"boolean","default":false,"description":"Whether the task is a pickup task","required":false},{"displayName":"Service Time","name":"serviceTime","type":"number","default":0,"description":"The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes","required":false}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"options":[{"displayName":"Complete After","name":"completeAfter","type":"dateTime","default":null,"description":"The earliest time the task should be completed"},{"displayName":"Complete Before","name":"completeBefore","type":"dateTime","default":null,"description":"The latest time the task should be completed"},{"displayName":"Executor ID","name":"executor","type":"string","default":"","description":"The ID of the organization that will be responsible for fulfilling the task"},{"displayName":"Merchant ID","name":"merchant","type":"string","default":"","description":"The ID of the organization that will be displayed to the recipient of the task"},{"displayName":"Notes","name":"notes","type":"string","default":"","description":"Notes for the task"},{"displayName":"Pick Up Task","name":"pickupTask","type":"boolean","default":false,"description":"Whether the task is a pickup task"},{"displayName":"Quantity","name":"quantity","type":"number","default":0,"description":"The number of units to be dropped off while completing this task, for route optimization purposes"},{"displayName":"Service Time","name":"serviceTime","type":"number","default":0,"description":"The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["complete"]}},"options":[{"displayName":"Notes","name":"notes","type":"string","default":"","description":"Completion Notes"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"options":[{"displayName":"Complete After","name":"completeAfter","type":"dateTime","default":null,"description":"The earliest time the task should be completed"},{"displayName":"Complete Before","name":"completeBefore","type":"dateTime","default":null,"description":"The latest time the task should be completed"},{"displayName":"Executor ID","name":"executor","type":"string","default":"","description":"The ID of the organization that will be responsible for fulfilling the task"},{"displayName":"Merchant ID","name":"merchant","type":"string","default":"","description":"The ID of the organization that will be displayed to the recipient of the task"},{"displayName":"Notes","name":"notes","type":"string","default":"","description":"Notes for the task"},{"displayName":"Pick Up Task","name":"pickupTask","type":"boolean","default":false,"description":"Whether the task is a pickup task"},{"displayName":"Quantity","name":"quantity","type":"number","default":0,"description":"The number of units to be dropped off while completing this task, for route optimization purposes"},{"displayName":"Recipient","name":"recipient","type":"fixedCollection","placeholder":"Add Recipient","default":{},"options":[{"displayName":"Recipient Properties","name":"recipientProperties","default":{},"values":[{"displayName":"Recipient Name","name":"recipientName","type":"string","description":"The recipient's complete name","default":"","required":true},{"displayName":"Recipient Phone","name":"recipientPhone","type":"string","description":"A unique, valid phone number as per the organization's country if there's no leading + sign. If a phone number has a leading + sign, it will disregard the organization's country setting.","default":"","required":true},{"displayName":"Recipient Notes","name":"recipientNotes","type":"string","default":"","description":"Notes for this recipient: these are global notes that should not be task- or destination-specific"},{"displayName":"Skip Recipient SMS Notifications","name":"recipientSkipSMSNotifications","type":"boolean","default":false,"description":"Whether this recipient has requested to skip SMS notifications"}]}]},{"displayName":"Recipient Name Override","name":"recipientName","type":"string","default":"","description":"Override the recipient name for this task only"},{"displayName":"Recipient Notes Override","name":"recipientNotes","type":"string","default":"","description":"Override the recipient notes for this task only"},{"displayName":"Recipient Skip SMS Notifications Override","name":"recipientSkipSMSNotifications","type":"boolean","default":false,"description":"Whether to override the recipient notification settings for this task"},{"displayName":"Service Time","name":"serviceTime","type":"number","default":0,"description":"The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes"},{"displayName":"Use Merchant For Proxy Override","name":"useMerchantForProxy","type":"boolean","default":false,"description":"Whether to override the organization ID with the merchant's org ID for this task"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["team"]}},"options":[{"name":"Auto-Dispatch","value":"autoDispatch","description":"Automatically dispatch tasks assigned to a team to on-duty drivers","action":"Auto-dispatch a team"},{"name":"Create","value":"create","description":"Create a new Onfleet team","action":"Create a team"},{"name":"Delete","value":"delete","description":"Delete an Onfleet team","action":"Delete a team"},{"name":"Get","value":"get","description":"Get a specific Onfleet team","action":"Get a team"},{"name":"Get Many","value":"getAll","description":"Get many Onfleet teams","action":"Get many teams"},{"name":"Get Time Estimates","value":"getTimeEstimates","description":"Get estimated times for upcoming tasks for a team, returns a selected driver","action":"Get time estimates for a team"},{"name":"Update","value":"update","description":"Update an Onfleet team","action":"Update a team"}],"default":"getAll"},{"displayName":"Team ID","name":"id","type":"string","displayOptions":{"show":{"resource":["team"],"operation":["get","update","delete","getTimeEstimates","autoDispatch"]}},"default":"","required":true,"description":"The ID of the team object for lookup"},{"displayName":"Name","name":"name","type":"string","default":"","description":"A unique name for the team","displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"required":true},{"displayName":"Worker Names or IDs","name":"workers","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getWorkers"},"default":[],"description":"A list of workers. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"required":true},{"displayName":"Administrator Names or IDs","name":"managers","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getAdmins"},"default":[],"description":"A list of managing administrators. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"required":true},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"options":[{"displayName":"Hub Name or ID","name":"hub","type":"options","typeOptions":{"loadOptionsMethod":"getHubs"},"default":"","description":"The team's hub. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Self Assignment","name":"enableSelfAssignment","type":"boolean","default":false,"description":"Whether or not to allow drivers to self-assign tasks that are in the Team's unassigned container"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["team"],"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":["team"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":64},"default":64,"description":"Max number of results to return"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["team"],"operation":["update"]}},"options":[{"displayName":"Administrator Names or IDs","name":"managers","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getAdmins"},"default":[],"description":"A list of managing administrators. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Hub Name or ID","name":"hub","type":"options","typeOptions":{"loadOptionsMethod":"getHubs"},"default":"","description":"The team's hub. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Name","name":"name","type":"string","default":"","description":"A unique name for the team"},{"displayName":"Self Assignment","name":"enableSelfAssignment","type":"boolean","default":false,"description":"Whether or not to allow drivers to self-assign tasks that are in the Team's unassigned container"},{"displayName":"Worker Names or IDs","name":"workers","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getWorkers"},"default":[],"description":"A list of workers. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["team"],"operation":["autoDispatch"]}},"options":[{"displayName":"Ending Route","name":"endingRoute","type":"fixedCollection","placeholder":"Add Route","default":{},"options":[{"displayName":"Ending Route Properties","name":"endingRouteProperties","type":"fixedCollection","default":{},"values":[{"displayName":"Route End","name":"routeEnd","type":"options","options":[{"name":"Team’s Hub","value":"team_hub"},{"name":"Worker Routing Address","value":"worker_routing_address"},{"name":"Hub","value":"hub"},{"name":"End Anywhere","value":"anywhere"}],"default":"","description":"Where the route will end","required":true},{"displayName":"Hub Name or ID","name":"hub","type":"options","typeOptions":{"loadOptionsMethod":"getHubs"},"default":"","description":"The team's hub. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"routeEnd":["hub"]}},"required":false}]}]},{"displayName":"Max Allowed Delay","name":"maxAllowedDelay","type":"number","default":10,"description":"Max allowed time in minutes that a task can be late","typeOptions":{"minValue":1}},{"displayName":"Max Number Of Tasks Per Route","name":"maxTasksPerRoute","type":"number","default":100,"typeOptions":{"maxValue":200,"minValue":1},"description":"Total number of tasks allowed on a route"},{"displayName":"Schedule Time Window","name":"scheduleTimeWindow","type":"fixedCollection","placeholder":"Add Time Window","default":{},"options":[{"displayName":"Schedule Time Window Properties","name":"scheduleTimeWindowProperties","type":"fixedCollection","default":{},"values":[{"displayName":"Start Time","name":"startTime","type":"dateTime","default":""},{"displayName":"End Time","name":"endTime","type":"dateTime","default":""}]}]},{"displayName":"Service Time","name":"serviceTime","type":"number","default":2,"typeOptions":{"minValue":0},"description":"The default service time to apply in Minutes to the tasks when no task service time exists"},{"displayName":"Task Time Window","name":"taskTimeWindow","type":"fixedCollection","placeholder":"Add Time Window","default":{},"options":[{"displayName":"Task Time Window Properties","name":"taskTimeWindowProperties","type":"fixedCollection","default":{},"values":[{"displayName":"Start Time","name":"startTime","type":"dateTime","default":""},{"displayName":"End Time","name":"endTime","type":"dateTime","default":""}]}]}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["team"],"operation":["getTimeEstimates"]}},"options":[{"displayName":"Drop Off","name":"dropOff","type":"fixedCollection","placeholder":"Add Drop Off","default":{},"options":[{"displayName":"DropOff Properties","name":"dropOffProperties","type":"fixedCollection","default":{},"values":[{"displayName":"Drop Off Longitude","name":"dropOffLongitude","type":"number","typeOptions":{"numberPrecision":14},"default":0,"description":"The longitude for drop off location","required":true},{"displayName":"Drop Off Latitude","name":"dropOffLatitude","type":"number","typeOptions":{"numberPrecision":14},"default":0,"description":"The latitude for drop off location","required":true}]}]},{"displayName":"Pick Up","name":"pickUp","type":"fixedCollection","default":{},"placeholder":"Add Pick Up","options":[{"displayName":"Pick Up Properties","name":"pickUpProperties","type":"fixedCollection","default":{},"values":[{"displayName":"Pick Up Longitude","name":"pickupLongitude","type":"number","typeOptions":{"numberPrecision":14},"default":0,"description":"The longitude for pickup location","required":true},{"displayName":"Pick Up Latitude","name":"pickupLatitude","type":"number","typeOptions":{"numberPrecision":14},"default":0,"description":"The latitude for pickup location","required":true},{"displayName":"Pick Up Time","name":"pickupTime","type":"dateTime","default":"","description":"If the request includes pickupLocation, pickupTime must be present if the time is fewer than 3 hours in the future","required":false}]}]},{"displayName":"Restricted Vehicle Types","name":"restrictedVehicleTypes","type":"options","options":[{"name":"Car","value":"CAR"},{"name":"Motorcycle","value":"MOTORCYCLE"},{"name":"Bicycle","value":"BICYCLE"},{"name":"Truck","value":"TRUCK"}],"default":"CAR","description":"Vehicle types to ignore in the query","required":false},{"displayName":"Service Time","name":"serviceTime","type":"number","default":120,"typeOptions":{"minValue":0},"description":"The expected time a worker will take at the pickupLocation, dropoffLocation, or both (as applicable) Unit: seconds","required":false}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["worker"]}},"options":[{"name":"Create","value":"create","description":"Create a new Onfleet worker","action":"Create a worker"},{"name":"Delete","value":"delete","description":"Delete an Onfleet worker","action":"Delete a worker"},{"name":"Get","value":"get","description":"Get a specific Onfleet worker","action":"Get a worker"},{"name":"Get Many","value":"getAll","description":"Get many Onfleet workers","action":"Get many workers"},{"name":"Get Schedule","value":"getSchedule","description":"Get a specific Onfleet worker schedule","action":"Get the schedule for a worker"},{"name":"Update","value":"update","description":"Update an Onfleet worker","action":"Update a worker"}],"default":"get"},{"displayName":"Search by Location","name":"byLocation","type":"boolean","default":false,"description":"Whether to search for only those workers who are currently within a certain target area","required":true,"displayOptions":{"show":{"resource":["worker"],"operation":["getAll"]}}},{"displayName":"Worker ID","name":"id","type":"string","displayOptions":{"show":{"resource":["worker"],"operation":["get","getSchedule","setSchedule","update","delete"]}},"default":"","required":true,"description":"The ID of the worker object for lookup"},{"displayName":"Name","name":"name","type":"string","default":"","description":"The worker's name","displayOptions":{"show":{"resource":["worker"],"operation":["create"]}},"required":true},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"A list of worker’s phone numbers","displayOptions":{"show":{"resource":["worker"],"operation":["create"]}},"required":true},{"displayName":"Team Names or IDs","name":"teams","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTeams"},"default":[],"description":"One or more teams of which the worker is a member. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","displayOptions":{"show":{"resource":["worker"],"operation":["create"]}},"required":true},{"displayName":"Longitude","name":"longitude","type":"number","typeOptions":{"numberPrecision":14},"default":0,"description":"The longitude component of the coordinate pair","displayOptions":{"show":{"resource":["worker"],"operation":["getAll"],"byLocation":[true]}},"required":true},{"displayName":"Latitude","name":"latitude","type":"number","typeOptions":{"numberPrecision":14},"default":0,"description":"The latitude component of the coordinate pair","displayOptions":{"show":{"resource":["worker"],"operation":["getAll"],"byLocation":[true]}},"required":true},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["worker"],"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":["worker"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":64},"default":64,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["worker"],"operation":["create"]}},"options":[{"displayName":"Capacity","name":"capacity","type":"number","default":0,"description":"The maximum number of units this worker can carry, for route optimization purposes"},{"displayName":"Display Name","name":"displayName","type":"string","default":"","description":"This value is used in place of the worker's actual name within sms notifications, delivery tracking pages, and across organization boundaries"},{"displayName":"Vehicle","name":"vehicle","type":"fixedCollection","placeholder":"Add Vehicle","default":{},"options":[{"displayName":"Vehicle Properties","name":"vehicleProperties","values":[{"displayName":"Type","name":"type","type":"options","options":[{"name":"Bicycle","value":"BICYCLE"},{"name":"Car","value":"CAR"},{"name":"Motorcycle","value":"MOTORCYCLE"},{"name":"Truck","value":"TRUCK"}],"default":"","description":"Whether the worker has vehicle or not. If it's not provided, this worker will be treated as if on foot.","required":true},{"displayName":"Description","name":"description","type":"string","default":"","description":"The vehicle's make, model, year, or any other relevant identifying details","required":false},{"displayName":"License Plate","name":"licensePlate","type":"string","default":"","description":"The vehicle's license plate number","required":false},{"displayName":"Color","name":"color","type":"string","default":"","description":"The vehicle's color","required":false}]}]}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["worker"],"operation":["update"]}},"options":[{"displayName":"Capacity","name":"capacity","type":"number","default":0,"description":"The maximum number of units this worker can carry, for route optimization purposes"},{"displayName":"Display Name","name":"displayName","type":"string","default":"","description":"This value is used in place of the worker's actual name within sms notifications, delivery tracking pages, and across organization boundaries"},{"displayName":"Name","name":"name","type":"string","default":"","description":"The worker's name"},{"displayName":"Team Names or IDs","name":"teams","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTeams"},"default":[],"description":"One or more teams of which the worker is a member. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["worker"],"operation":["getAll"],"byLocation":[true]}},"options":[{"displayName":"Radius","name":"radius","type":"number","typeOptions":{"maxValue":10000,"minValue":0},"default":1000,"description":"The length in meters of the radius of the spherical area in which to look for workers. Defaults to 1000 if missing. Maximum value is 10000."}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["worker"],"operation":["getAll"],"byLocation":[false]}},"options":[{"displayName":"States","name":"states","type":"multiOptions","options":[{"name":"Active (On-Duty, Active Task)","value":2},{"name":"Idle (On-Duty, No Active Task)","value":1},{"name":"Off-Duty","value":0}],"default":[],"description":"List of worker states"},{"displayName":"Team Names or IDs","name":"teams","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTeams"},"default":[],"description":"A list of the teams that workers must be part of. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phones","name":"phones","type":"string","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Phone"},"default":[],"description":"A list of workers' phone numbers"}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["worker"],"operation":["getAll"]}},"options":[{"displayName":"Fields to Return","name":"filter","type":"multiOptions","options":[{"name":"Account Status","value":"accountStatus"},{"name":"Active Task","value":"activeTask"},{"name":"Capacity","value":"capacity"},{"name":"Delay Time","value":"delayTime"},{"name":"Display Name","value":"displayName"},{"name":"Image Url","value":"imageUrl"},{"name":"Location","value":"location"},{"name":"Metadata","value":"metadata"},{"name":"Name","value":"name"},{"name":"On Duty","value":"onDuty"},{"name":"Organization","value":"organization"},{"name":"Phone","value":"phone"},{"name":"Tasks","value":"tasks"},{"name":"Teams","value":"teams"},{"name":"Time Created","value":"timeCreated"},{"name":"Time Last Modified","value":"timeLastModified"},{"name":"Time Last Seen","value":"timeLastSeen"},{"name":"User Data","value":"userData"},{"name":"Vehicle","value":"vehicle"},{"name":"Worker ID","value":"id"}],"default":[],"description":"A list of fields to show in the response, if all are not desired"}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["worker"],"operation":["get"]}},"options":[{"displayName":"Analytics","name":"analytics","type":"boolean","default":true,"description":"Whether a more detailed response is needed, includes basic worker duty event, traveled distance (meters) and time analytics"},{"displayName":"Fields to Return","name":"filter","type":"multiOptions","options":[{"name":"Account Status","value":"accountStatus"},{"name":"Active Task","value":"activeTask"},{"name":"Capacity","value":"capacity"},{"name":"Delay Time","value":"delayTime"},{"name":"Display Name","value":"displayName"},{"name":"Image Url","value":"imageUrl"},{"name":"Location","value":"location"},{"name":"Metadata","value":"metadata"},{"name":"Name","value":"name"},{"name":"On Duty","value":"onDuty"},{"name":"Organization","value":"organization"},{"name":"Phone","value":"phone"},{"name":"Tasks","value":"tasks"},{"name":"Teams","value":"teams"},{"name":"Time Created","value":"timeCreated"},{"name":"Time Last Modified","value":"timeLastModified"},{"name":"Time Last Seen","value":"timeLastSeen"},{"name":"User Data","value":"userData"},{"name":"Vehicle","value":"vehicle"},{"name":"Worker ID","value":"id"}],"default":[],"description":"A list of fields to show in the response, if all are not desired","required":false}]},{"displayName":"Schedule","name":"schedule","type":"fixedCollection","placeholder":"Add Schedule","displayOptions":{"show":{"resource":["worker"],"operation":["setSchedule"]}},"default":{},"typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Schedule"},"options":[{"displayName":"Schedule Properties","name":"scheduleProperties","default":{},"values":[{"displayName":"Date","name":"date","type":"dateTime","default":"","description":"Schedule's date","required":true},{"displayName":"Timezone Name or ID","name":"timezone","type":"options","typeOptions":{"loadOptionsMethod":"getTimezones"},"default":"","description":"A valid timezone. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","required":true},{"displayName":"Shifts","name":"shifts","type":"fixedCollection","default":{},"placeholder":"Add Shift","typeOptions":{"multipleValues":true},"options":[{"displayName":"Shifts Properties","name":"shiftsProperties","default":{},"values":[{"displayName":"Start","name":"start","type":"dateTime","default":"","description":"Start time","required":true},{"displayName":"End","name":"end","type":"dateTime","default":"","description":"End time","required":true}]}]}]}]}]

operations:
  [{"type":"resource","resource":"admin","name":"Admin"},{"type":"resource","resource":"container","name":"Container"},{"type":"resource","resource":"destination","name":"Destination"},{"type":"resource","resource":"hub","name":"Hub"},{"type":"resource","resource":"organization","name":"Organization"},{"type":"resource","resource":"recipient","name":"Recipient"},{"type":"resource","resource":"task","name":"Task"},{"type":"resource","resource":"team","name":"Team"},{"type":"resource","resource":"worker","name":"Worker"},{"type":"operation","operation":"create","name":"Create","action":"Create an admin","resources":["admin"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an admin","resources":["admin"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many admins","resources":["admin"]},{"type":"operation","operation":"update","name":"Update","action":"Update an admin","resources":["admin"]},{"type":"operation","operation":"addTask","name":"Add Tasks","action":"Add tasks","resources":["container"]},{"type":"operation","operation":"get","name":"Get","action":"Get a container","resources":["container"]},{"type":"operation","operation":"updateTask","name":"Update Tasks","action":"Update tasks","resources":["container"]},{"type":"operation","operation":"create","name":"Create","action":"Create a destination","resources":["destination"]},{"type":"operation","operation":"get","name":"Get","action":"Get a destination","resources":["destination"]},{"type":"operation","operation":"create","name":"Create","action":"Create a hub","resources":["hub"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many hubs","resources":["hub"]},{"type":"operation","operation":"update","name":"Update","action":"Update a hub","resources":["hub"]},{"type":"operation","operation":"get","name":"Get My Organization","action":"Get my organization","resources":["organization"]},{"type":"operation","operation":"getDelegatee","name":"Get Delegatee Details","action":"Get a delegatee's details","resources":["organization"]},{"type":"operation","operation":"create","name":"Create","action":"Create a recipient","resources":["recipient"]},{"type":"operation","operation":"get","name":"Get","action":"Get a recipient","resources":["recipient"]},{"type":"operation","operation":"update","name":"Update","action":"Update a recipient","resources":["recipient"]},{"type":"operation","operation":"clone","name":"Clone","action":"Clone a task","resources":["task"]},{"type":"operation","operation":"complete","name":"Complete","action":"Complete a task","resources":["task"]},{"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":"autoDispatch","name":"Auto-Dispatch","action":"Auto-dispatch a team","resources":["team"]},{"type":"operation","operation":"create","name":"Create","action":"Create a team","resources":["team"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a team","resources":["team"]},{"type":"operation","operation":"get","name":"Get","action":"Get a team","resources":["team"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many teams","resources":["team"]},{"type":"operation","operation":"getTimeEstimates","name":"Get Time Estimates","action":"Get time estimates for a team","resources":["team"]},{"type":"operation","operation":"update","name":"Update","action":"Update a team","resources":["team"]},{"type":"operation","operation":"create","name":"Create","action":"Create a worker","resources":["worker"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a worker","resources":["worker"]},{"type":"operation","operation":"get","name":"Get","action":"Get a worker","resources":["worker"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many workers","resources":["worker"]},{"type":"operation","operation":"getSchedule","name":"Get Schedule","action":"Get the schedule for a worker","resources":["worker"]},{"type":"operation","operation":"update","name":"Update","action":"Update a worker","resources":["worker"]}]


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

  # Onfleet Trigger node

  [Onfleet](https://onfleet.com/){:target=_blank .external-link} is a logistics platform offering a last-mile delivery solution.

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

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

  ## Events

  Trigger a workflow on:

  * SMS recipient opt out
  * SMS recipient response missed
  * Task arrival
  * Task assigned
  * Task cloned
  * Task completed
  * Task created
  * Task delayed
  * Task ETA
  * Task failed
  * Task started
  * Task unassigned
  * Task updated
  * Worker created
  * Worker deleted
  * Worker duty

properties_schema:
  [{"displayName":"Trigger On","name":"triggerOn","type":"options","options":[{"name":"SMS Recipient Opt Out","value":"SMSRecipientOptOut"},{"name":"SMS Recipient Response Missed","value":"smsRecipientResponseMissed"},{"name":"Task Arrival","value":"taskArrival"},{"name":"Task Assigned","value":"taskAssigned"},{"name":"Task Cloned","value":"taskCloned"},{"name":"Task Completed","value":"taskCompleted"},{"name":"Task Created","value":"taskCreated"},{"name":"Task Delayed","value":"taskDelayed"},{"name":"Task Deleted","value":"taskDeleted"},{"name":"Task ETA","value":"taskEta"},{"name":"Task Failed","value":"taskFailed"},{"name":"Task Started","value":"taskStarted"},{"name":"Task Unassigned","value":"taskUnassigned"},{"name":"Task Updated","value":"taskUpdated"},{"name":"Worker Created","value":"workerCreated"},{"name":"Worker Deleted","value":"workerDeleted"},{"name":"Worker Duty","value":"workerDuty"}],"required":true,"default":[]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"A name for the webhook for identification"}]}]


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

  # Notion node

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

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

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

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

  ## Operations

  * Block
  	* Append After
  	* Get Child Blocks
  * Database
  	* Get
  	* Get Many
  	* Search
  * Database Page
  	* Create
  	* Get
  	* Get Many
  	* Update
  * Page
  	* Archive
  	* Create
  	* Search
  * User
  	* Get
  	* Get Many

  ## Templates and examples

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

  ## Related resources

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

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

  --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.notion/common-issues.md).


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

  # Notion Trigger node

  [Notion](https://notion.so){:target=_blank .external-link} is an all-in-one workspace for your notes, tasks, wikis, and databases.

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

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

  ## Events

  * Page added to database
  * Page updated in database

  ## Related resources

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

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

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

properties_schema:
  [{"displayName":"Event","name":"event","type":"options","options":[{"name":"Page Added to Database","value":"pageAddedToDatabase"},{"name":"Page Updated in Database","value":"pagedUpdatedInDatabase"}],"required":true,"default":"pageAddedToDatabase"},{"displayName":"In Notion, make sure to <a href=\"https://www.notion.so/help/add-and-manage-connections-with-the-api\" target=\"_blank\">add your connection</a> to the pages you want to access.","name":"notionNotice","type":"notice","default":""},{"displayName":"Database","name":"databaseId","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"modes":[{"displayName":"Database","name":"list","type":"list","placeholder":"Select a Database...","typeOptions":{"searchListMethod":"getDatabases","searchable":true}},{"displayName":"Link","name":"url","type":"string","placeholder":"https://www.notion.so/0fe2f7de558b471eab07e9d871cdf4a9?v=f2d424ba0c404733a3f500c78c881610","validation":[{"type":"regex","properties":{"regex":"(?:https|http)://www.notion.so/(?:[a-z0-9-]{2,}/)?([0-9a-f]{8}[0-9a-f]{4}4[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12}).*","errorMessage":"Not a valid Notion Database URL"}}],"extractValue":{"type":"regex","regex":"(?:https|http)://www.notion.so/(?:[a-z0-9-]{2,}/)?([0-9a-f]{8}[0-9a-f]{4}4[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})"}},{"displayName":"ID","name":"id","type":"string","placeholder":"ab1545b247fb49fa92d6f4b49f4d8116","validation":[{"type":"regex","properties":{"regex":"^(([0-9a-f]{8}[0-9a-f]{4}4[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})|([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}))[ \t]*","errorMessage":"Not a valid Notion Database ID"}}],"extractValue":{"type":"regex","regex":"^([0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12})"},"url":"=https://www.notion.so/{{$value.replace(/-/g, \"\")}}"}],"displayOptions":{"show":{"event":["pageAddedToDatabase","pagedUpdatedInDatabase"]}},"description":"The Notion Database to operate on"},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"event":["pageAddedToDatabase","pagedUpdatedInDatabase"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"}]


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

  # npm node

  Use the npm node to automate work in npm, and integrate npm with other applications.

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

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

  ## Operations

  * Package
  	* Get Package Metadata
  	* Get Package Versions
  	* Search for Packages
  * Distribution Tag
  	* Get All Tags
  	* Update a Tag

  ## Templates and examples

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

  ## Related resources

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Package","value":"package"},{"name":"Distribution Tag","value":"distTag"}],"default":"package"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"getMetadata","displayOptions":{"show":{"resource":["package"]}},"options":[{"name":"Get Metadata","value":"getMetadata","action":"Returns all the metadata for a package at a specific version","description":"Returns all the metadata for a package at a specific version","routing":{"request":{"method":"GET","url":"=/{{ encodeURIComponent($parameter.packageName) }}/{{ $parameter.packageVersion }}"}}},{"name":"Get Versions","value":"getVersions","action":"Returns all the versions for a package","description":"Returns all the versions for a package","routing":{"request":{"method":"GET","url":"=/{{ encodeURIComponent($parameter.packageName) }}"},"output":{"postReceive":[null]}}},{"name":"Search","value":"search","action":"Search for packages","description":"Search for packages","routing":{"request":{"method":"GET","url":"/-/v1/search","qs":{"text":"={{$parameter.query}}","size":"={{$parameter.limit}}","from":"={{$parameter.offset}}","popularity":0.99}},"output":{"postReceive":[null]}}}]},{"displayName":"Package Name","name":"packageName","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["package"],"operation":["getMetadata","getVersions"]}}},{"displayName":"Package Version","name":"packageVersion","type":"string","required":true,"default":"latest","displayOptions":{"show":{"resource":["package"],"operation":["getMetadata"]}}},{"displayName":"Query","name":"query","type":"string","required":true,"displayOptions":{"show":{"resource":["package"],"operation":["search"]}},"default":"","description":"The query text used to search for packages"},{"displayName":"Limit","name":"limit","type":"number","default":10,"typeOptions":{"minValue":1,"maxValue":100},"displayOptions":{"show":{"resource":["package"],"operation":["search"]}},"description":"Max number of results to return"},{"displayName":"Offset","name":"offset","type":"number","default":0,"typeOptions":{"minValue":0},"displayOptions":{"show":{"resource":["package"],"operation":["search"]}},"description":"Offset to return results from"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"default":"getMany","displayOptions":{"show":{"resource":["distTag"]}},"options":[{"name":"Get All","value":"getMany","action":"Returns all the dist-tags for a package","description":"Returns all the dist-tags for a package","routing":{"request":{"method":"GET","url":"=/-/package/{{ encodeURIComponent($parameter.packageName) }}/dist-tags"}}},{"name":"Update","value":"update","action":"Update a the dist-tags for a package","description":"Update a the dist-tags for a package","routing":{"request":{"method":"PUT","url":"=/-/package/{{ encodeURIComponent($parameter.packageName) }}/dist-tags/{{ encodeURIComponent($parameter.distTagName) }}"},"send":{"preSend":[null]}}}]},{"displayName":"Package Name","name":"packageName","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["distTag"],"operation":["getMany","update"]}}},{"displayName":"Package Version","name":"packageVersion","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["distTag"],"operation":["update"]}}},{"displayName":"Distribution Tag Name","name":"distTagName","type":"string","required":true,"default":"latest","displayOptions":{"show":{"resource":["distTag"],"operation":["update"]}}}]

operations:
  [{"type":"resource","resource":"package","name":"Package"},{"type":"resource","resource":"distTag","name":"Distribution Tag"},{"type":"operation","operation":"getMetadata","name":"Get Metadata","action":"Returns all the metadata for a package at a specific version","resources":["package"]},{"type":"operation","operation":"getVersions","name":"Get Versions","action":"Returns all the versions for a package","resources":["package"]},{"type":"operation","operation":"search","name":"Search","action":"Search for packages","resources":["package"]},{"type":"operation","operation":"getMany","name":"Get All","action":"Returns all the dist-tags for a package","resources":["distTag"]},{"type":"operation","operation":"update","name":"Update","action":"Update a the dist-tags for a package","resources":["distTag"]}]


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

  # Odoo node

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

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

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

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

  ## Operations

  * Contact
      * Create a new contact
      * Delete a contact
      * Get a contact
      * Get all contacts
      * Update a contact
  * Custom Resource
      * Create a new item
      * Delete an item
      * Get an item
      * Get all items
      * Update an item
  * Note
      * Create a new note
      * Delete a note
      * Get a note
      * Get all notes
      * Update a note
  * Opportunity
      * Create a new opportunity
      * Delete an opportunity
      * Get an opportunity
      * Get all opportunities
      * Update an opportunity

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","default":"contact","noDataExpression":true,"options":[{"name":"Contact","value":"contact"},{"name":"Custom Resource","value":"custom"},{"name":"Note","value":"note"},{"name":"Opportunity","value":"opportunity"}]},{"displayName":"Custom Resource Name or ID","name":"customResource","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getModels"},"displayOptions":{"show":{"resource":["custom"]}}},{"displayName":"Operation","name":"operation","type":"options","default":"create","noDataExpression":true,"displayOptions":{"show":{"resource":["custom"]}},"options":[{"name":"Create","value":"create","description":"Create a new item","action":"Create an item"},{"name":"Delete","value":"delete","description":"Delete an item","action":"Delete an item"},{"name":"Get","value":"get","description":"Get an item","action":"Get an item"},{"name":"Get Many","value":"getAll","description":"Get many items","action":"Get many items"},{"name":"Update","value":"update","description":"Update an item","action":"Update an item"}]},{"displayName":"Fields","name":"fieldsToCreateOrUpdate","type":"fixedCollection","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Field"},"default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["custom"]}},"options":[{"displayName":"Field Record:","name":"fields","values":[{"displayName":"Field Name or ID","name":"fieldName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getModelFields"}},{"displayName":"New Value","name":"fieldValue","type":"string","default":""}]}]},{"displayName":"Custom Resource ID","name":"customResourceId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["get","delete"],"resource":["custom"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["custom"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":50,"displayOptions":{"show":{"resource":["custom"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll","get"],"resource":["custom"]}},"options":[{"displayName":"Fields to Include","name":"fieldsList","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":"getModelFields","loadOptionsDependsOn":["customResource"]}}]},{"displayName":"Filters","name":"filterRequest","type":"fixedCollection","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Filter"},"default":{},"description":"Filter request by applying filters","placeholder":"Add condition","displayOptions":{"show":{"operation":["getAll"],"resource":["custom"]}},"options":[{"name":"filter","displayName":"Filter","values":[{"displayName":"Field Name or ID","name":"fieldName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsDependsOn":["customResource"],"loadOptionsMethod":"getModelFields"}},{"displayName":"Operator","name":"operator","type":"options","default":"equal","description":"Specify an operator","options":[{"name":"!=","value":"notEqual"},{"name":"<","value":"lesserThen"},{"name":"<=","value":"lesserOrEqual"},{"name":"=","value":"equal"},{"name":">","value":"greaterThen"},{"name":">=","value":"greaterOrEqual"},{"name":"Child Of","value":"childOf"},{"name":"In","value":"in"},{"name":"Like","value":"like"},{"name":"Not In","value":"notIn"}]},{"displayName":"Value","name":"value","type":"string","default":"","description":"Specify value for comparison"}]}]},{"displayName":"Custom Resource ID","name":"customResourceId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["custom"]}}},{"displayName":"Update Fields","name":"fieldsToCreateOrUpdate","type":"fixedCollection","typeOptions":{"multipleValues":true,"multipleValueButtonText":"Add Field"},"default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["custom"]}},"options":[{"displayName":"Field Record:","name":"fields","values":[{"displayName":"Field Name or ID","name":"fieldName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getModelFields"}},{"displayName":"New Value","name":"fieldValue","type":"string","default":""}]}]},{"displayName":"Operation","name":"operation","type":"options","default":"create","noDataExpression":true,"displayOptions":{"show":{"resource":["opportunity"]}},"options":[{"name":"Create","value":"create","description":"Create a new opportunity","action":"Create an opportunity"},{"name":"Delete","value":"delete","description":"Delete an opportunity","action":"Delete an opportunity"},{"name":"Get","value":"get","description":"Get an opportunity","action":"Get an opportunity"},{"name":"Get Many","value":"getAll","description":"Get many opportunities","action":"Get many opportunities"},{"name":"Update","value":"update","description":"Update an opportunity","action":"Update an opportunity"}]},{"displayName":"Name","name":"opportunityName","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["opportunity"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["opportunity"]}},"options":[{"displayName":"Email","name":"email_from","type":"string","default":""},{"displayName":"Expected Revenue","name":"expected_revenue","type":"number","default":0},{"displayName":"Internal Notes","name":"description","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""},{"displayName":"Priority","name":"priority","type":"options","default":"1","options":[{"name":"1","value":"1"},{"name":"2","value":"2"},{"name":"3","value":"3"}]},{"displayName":"Probability","name":"probability","type":"number","default":0,"typeOptions":{"maxValue":100,"minValue":0}}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["get","delete"],"resource":["opportunity"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":50,"displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll","get"],"resource":["opportunity"]}},"options":[{"displayName":"Fields to Include","name":"fieldsList","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":"getModelFields"}}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["opportunity"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["opportunity"]}},"options":[{"displayName":"Email","name":"email_from","type":"string","default":""},{"displayName":"Expected Revenue","name":"expected_revenue","type":"number","default":0},{"displayName":"Internal Notes","name":"description","type":"string","default":""},{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""},{"displayName":"Priority","name":"priority","type":"options","default":"1","options":[{"name":"1","value":"1"},{"name":"2","value":"2"},{"name":"3","value":"3"}]},{"displayName":"Probability","name":"probability","type":"number","default":0,"typeOptions":{"maxValue":100,"minValue":0}}]},{"displayName":"Operation","name":"operation","type":"options","default":"create","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"options":[{"name":"Create","value":"create","description":"Create a new contact","action":"Create a contact"},{"name":"Delete","value":"delete","description":"Delete a contact","action":"Delete a contact"},{"name":"Get","value":"get","description":"Get a contact","action":"Get a contact"},{"name":"Get Many","value":"getAll","description":"Get many contacts","action":"Get many contacts"},{"name":"Update","value":"update","description":"Update a contact","action":"Update a contact"}]},{"displayName":"Name","name":"contactName","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["contact"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["contact"]}},"options":[{"displayName":"Address","name":"address","type":"fixedCollection","default":{},"placeholder":"Add Address","typeOptions":{"multipleValues":false},"options":[{"name":"value","displayName":"Address","values":[{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"Country Name or ID","name":"country_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>","default":"","typeOptions":{"loadOptionsMethod":"getCountries"}},{"displayName":"State Name or ID","name":"state_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>","default":"","typeOptions":{"loadOptionsMethod":"getStates"}},{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"Street 2","name":"street2","type":"string","default":""},{"displayName":"Zip Code","name":"zip","type":"string","default":""}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Internal Notes","name":"comment","type":"string","default":""},{"displayName":"Job Position","name":"function","type":"string","default":""},{"displayName":"Mobile","name":"mobile","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""},{"displayName":"Tax ID","name":"vat","type":"string","default":""},{"displayName":"Website","name":"website","type":"string","default":""}]},{"displayName":"Contact ID","name":"contactId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["get","delete"],"resource":["contact"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":50,"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll","get"],"resource":["contact"]}},"options":[{"displayName":"Fields to Include","name":"fieldsList","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":"getModelFields"}}]},{"displayName":"Contact ID","name":"contactId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["contact"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["contact"]}},"options":[{"displayName":"Address","name":"address","type":"fixedCollection","default":{},"placeholder":"Add Address","typeOptions":{"multipleValues":false},"options":[{"name":"value","displayName":"Address","values":[{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"Country Name or ID","name":"country_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>","default":"","typeOptions":{"loadOptionsMethod":"getCountries"}},{"displayName":"State Name or ID","name":"state_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>","default":"","typeOptions":{"loadOptionsMethod":"getStates"}},{"displayName":"Street","name":"street","type":"string","default":""},{"displayName":"Street 2","name":"street2","type":"string","default":""},{"displayName":"Zip Code","name":"zip","type":"string","default":""}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":""},{"displayName":"Internal Notes","name":"comment","type":"string","default":""},{"displayName":"Job Position","name":"function","type":"string","default":""},{"displayName":"Mobile","name":"mobile","type":"string","default":""},{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""},{"displayName":"Tax ID","name":"vat","type":"string","default":""},{"displayName":"Website","name":"website","type":"string","default":""}]},{"displayName":"Operation","name":"operation","type":"options","default":"create","noDataExpression":true,"displayOptions":{"show":{"resource":["note"]}},"options":[{"name":"Create","value":"create","description":"Create a new note","action":"Create a note"},{"name":"Delete","value":"delete","description":"Delete a note","action":"Delete a note"},{"name":"Get","value":"get","description":"Get a note","action":"Get a note"},{"name":"Get Many","value":"getAll","description":"Get many notes","action":"Get many notes"},{"name":"Update","value":"update","description":"Update a note","action":"Update a note"}]},{"displayName":"Memo","name":"memo","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["note"]}}},{"displayName":"Note ID","name":"noteId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["get","delete"],"resource":["note"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["note"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","default":50,"displayOptions":{"show":{"resource":["note"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll","get"],"resource":["note"]}},"options":[{"displayName":"Fields to Include","name":"fieldsList","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":"getModelFields"}}]},{"displayName":"Note ID","name":"noteId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["note"]}}},{"displayName":"Memo","name":"memo","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["note"]}}}]

operations:
  [{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"custom","name":"Custom Resource"},{"type":"resource","resource":"note","name":"Note"},{"type":"resource","resource":"opportunity","name":"Opportunity"},{"type":"operation","operation":"create","name":"Create","action":"Create an item","resources":["custom"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an item","resources":["custom"]},{"type":"operation","operation":"get","name":"Get","action":"Get an item","resources":["custom"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many items","resources":["custom"]},{"type":"operation","operation":"update","name":"Update","action":"Update an item","resources":["custom"]},{"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 contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact","resources":["contact"]},{"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":"get","name":"Get","action":"Get a note","resources":["note"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many notes","resources":["note"]},{"type":"operation","operation":"update","name":"Update","action":"Update a note","resources":["note"]}]


node_type: oneSimpleApi
package_name: n8n-nodes-base
display_name: One Simple API
description: A toolbox of no-code utilities
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"oneSimpleApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: One Simple API node documentation
  description: Learn how to use the One Simple API node in n8n. Follow technical documentation to integrate One Simple API node into your workflows.
  contentType: [integration, reference]
  ---
  <!-- vale off -->
  <!-- linting off because 'simple' isn't something I want to add to accept.txt -->
  # One Simple API node

  Use the One Simple API node to automate work in One Simple API, and integrate One Simple API with other applications. n8n has built-in support for a wide range of One Simple API features, including getting profiles, retrieving information, and generating utilities. 

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

  /// note | Credentials
  Refer to [One Simple API credentials](/integrations/builtin/credentials/onesimpleapi.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Information
      * Convert a value between currencies
      * Retrieve image metadata from a URL
  * Social Profile
      * Get details about an Instagram profile
      * Get details about a Spotify Artist
  * Utility
      * Expand a shortened url
      * Generate a QR Code
      * Validate an email address
  * Website
      * Generate a PDF from a webpage
      * Get SEO information from website
      * Create a screenshot from a webpage

  ## Templates and examples

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

  ## Related resources

  Refer to [One Simple API's documentation](https://onesimpleapi.com/docs){:target=_blank .external-link} for more information about the service.

  <!-- vale on -->

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Information","value":"information"},{"name":"Social Profile","value":"socialProfile"},{"name":"Utility","value":"utility"},{"name":"Website","value":"website"}],"default":"website","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["website"]}},"options":[{"name":"Generate PDF","value":"pdf","description":"Generate a PDF from a webpage","action":"Generate PDF"},{"name":"Get SEO Data","value":"seo","description":"Get SEO information from website","action":"Get SEO Data"},{"name":"Take Screenshot","value":"screenshot","description":"Create a screenshot from a webpage","action":"Screenshot"}],"default":"pdf"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["socialProfile"]}},"options":[{"name":"Instagram","value":"instagramProfile","description":"Get details about an Instagram profile","action":"Get details about an Instagram profile"},{"name":"Spotify","value":"spotifyArtistProfile","description":"Get details about a Spotify Artist","action":"Get details about a Spotify artist"}],"default":"instagramProfile"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["information"]}},"options":[{"name":"Exchange Rate","value":"exchangeRate","description":"Convert a value between currencies","action":"Convert a value between currencies"},{"name":"Image Metadata","value":"imageMetadata","description":"Retrieve image metadata from a URL","action":"Get image metadata from a URL"}],"default":"exchangeRate"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["utility"]}},"options":[{"name":"Expand URL","value":"expandURL","description":"Expand a shortened URL","action":"Expand a shortened URL"},{"name":"Generate QR Code","value":"qrCode","description":"Generate a QR Code","action":"Generate a QR code utility"},{"name":"Validate Email","value":"validateEmail","description":"Validate an email address","action":"Validate an email address"}],"default":"validateEmail"},{"displayName":"Webpage URL","name":"link","type":"string","required":true,"displayOptions":{"show":{"operation":["pdf"],"resource":["website"]}},"default":"","description":"Link to webpage to convert"},{"displayName":"Download PDF?","name":"download","type":"boolean","required":true,"displayOptions":{"show":{"operation":["pdf"],"resource":["website"]}},"default":false,"description":"Whether to download the PDF or return a link to it"},{"displayName":"Put Output In Field","name":"output","type":"string","required":true,"displayOptions":{"show":{"operation":["pdf"],"resource":["website"],"download":[true]}},"default":"data","description":"The name of the output field to put the binary file data in"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["website"],"operation":["pdf"]}},"options":[{"displayName":"Page Size","name":"page","type":"options","options":[{"name":"A0","value":"A0"},{"name":"A1","value":"A1"},{"name":"A2","value":"A2"},{"name":"A3","value":"A3"},{"name":"A4","value":"A4"},{"name":"A5","value":"A5"},{"name":"A6","value":"A6"},{"name":"Ledger","value":"Ledger"},{"name":"Legal","value":"Legal"},{"name":"Letter","value":"Letter"},{"name":"Tabloid","value":"Tabloid"}],"default":""},{"displayName":"Force Refresh","name":"force","type":"boolean","default":false,"description":"Normally the API will reuse a previously taken screenshot of the URL to give a faster response. This option allows you to retake the screenshot at that exact time, for those times when it's necessary."}]},{"displayName":"QR Content","name":"message","type":"string","required":true,"displayOptions":{"show":{"operation":["qrCode"],"resource":["utility"]}},"default":"","description":"The text that should be turned into a QR code - like a website URL"},{"displayName":"Download Image?","name":"download","type":"boolean","required":true,"displayOptions":{"show":{"operation":["qrCode"],"resource":["utility"]}},"default":false,"description":"Whether to download the QR code or return a link to it"},{"displayName":"Put Output In Field","name":"output","type":"string","required":true,"displayOptions":{"show":{"operation":["qrCode"],"resource":["utility"],"download":[true]}},"default":"data","description":"The name of the output field to put the binary file data in"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["utility"],"operation":["qrCode"]}},"options":[{"displayName":"Size","name":"size","type":"options","options":[{"name":"Small","value":"Small"},{"name":"Medium","value":"Medium"},{"name":"Large","value":"Large"}],"default":"Small","description":"The QR Code size"},{"displayName":"Format","name":"format","type":"options","options":[{"name":"PNG","value":"PNG"},{"name":"SVG","value":"SVG"}],"default":"PNG","description":"The QR Code format"}]},{"displayName":"Webpage URL","name":"link","type":"string","required":true,"displayOptions":{"show":{"operation":["screenshot"],"resource":["website"]}},"default":"","description":"Link to webpage to convert"},{"displayName":"Download Screenshot?","name":"download","type":"boolean","required":true,"displayOptions":{"show":{"operation":["screenshot"],"resource":["website"]}},"default":false,"description":"Whether to download the screenshot or return a link to it"},{"displayName":"Put Output In Field","name":"output","type":"string","required":true,"displayOptions":{"show":{"operation":["screenshot"],"resource":["website"],"download":[true]}},"default":"data","description":"The name of the output field to put the binary file data in"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["website"],"operation":["screenshot"]}},"options":[{"displayName":"Screen Size","name":"screen","type":"options","options":[{"name":"Phone","value":"phone"},{"name":"Phone Landscape","value":"phone-landscape"},{"name":"Retina","value":"retina"},{"name":"Tablet","value":"tablet"},{"name":"Tablet Landscape","value":"tablet-landscape"}],"default":""},{"displayName":"Force Refresh","name":"force","type":"boolean","default":false,"description":"Normally the API will reuse a previously taken screenshot of the URL to give a faster response. This option allows you to retake the screenshot at that exact time, for those times when it's necessary."},{"displayName":"Full Page","name":"fullpage","type":"boolean","default":false,"description":"The API takes a screenshot of the viewable area for the desired screen size. If you need a screenshot of the whole length of the page, use this option."}]},{"displayName":"Profile Name","name":"profileName","type":"string","required":true,"displayOptions":{"show":{"operation":["instagramProfile"],"resource":["socialProfile"]}},"default":"","description":"Profile name to get details of"},{"displayName":"Artist Name","name":"artistName","type":"string","required":true,"displayOptions":{"show":{"operation":["spotifyArtistProfile"],"resource":["socialProfile"]}},"default":"","description":"Artist name to get details for"},{"displayName":"Value","name":"value","type":"string","required":true,"displayOptions":{"show":{"operation":["exchangeRate"],"resource":["information"]}},"default":"","description":"Value to convert"},{"displayName":"From Currency","name":"fromCurrency","type":"string","required":true,"placeholder":"USD","displayOptions":{"show":{"operation":["exchangeRate"],"resource":["information"]}},"default":""},{"displayName":"To Currency","name":"toCurrency","type":"string","placeholder":"EUR","required":true,"displayOptions":{"show":{"operation":["exchangeRate"],"resource":["information"]}},"default":""},{"displayName":"Link To Image","name":"link","type":"string","required":true,"displayOptions":{"show":{"operation":["imageMetadata"],"resource":["information"]}},"default":"","description":"Image to get metadata from"},{"displayName":"Webpage URL","name":"link","type":"string","required":true,"displayOptions":{"show":{"operation":["seo"],"resource":["website"]}},"default":"","description":"Webpage to get SEO information for"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["website"],"operation":["seo"]}},"options":[{"displayName":"Include Headers?","name":"headers","type":"boolean","default":false}]},{"displayName":"Email Address","name":"emailAddress","type":"string","required":true,"displayOptions":{"show":{"operation":["validateEmail"],"resource":["utility"]}},"default":""},{"displayName":"URL","name":"link","type":"string","required":true,"displayOptions":{"show":{"operation":["expandURL"],"resource":["utility"]}},"default":"","description":"URL to unshorten"}]

operations:
  [{"type":"resource","resource":"information","name":"Information"},{"type":"resource","resource":"socialProfile","name":"Social Profile"},{"type":"resource","resource":"utility","name":"Utility"},{"type":"resource","resource":"website","name":"Website"},{"type":"operation","operation":"pdf","name":"Generate PDF","action":"Generate PDF","resources":["website"]},{"type":"operation","operation":"seo","name":"Get SEO Data","action":"Get SEO Data","resources":["website"]},{"type":"operation","operation":"screenshot","name":"Take Screenshot","action":"Screenshot","resources":["website"]},{"type":"operation","operation":"instagramProfile","name":"Instagram","action":"Get details about an Instagram profile","resources":["socialProfile"]},{"type":"operation","operation":"spotifyArtistProfile","name":"Spotify","action":"Get details about a Spotify artist","resources":["socialProfile"]},{"type":"operation","operation":"exchangeRate","name":"Exchange Rate","action":"Convert a value between currencies","resources":["information"]},{"type":"operation","operation":"imageMetadata","name":"Image Metadata","action":"Get image metadata from a URL","resources":["information"]},{"type":"operation","operation":"expandURL","name":"Expand URL","action":"Expand a shortened URL","resources":["utility"]},{"type":"operation","operation":"qrCode","name":"Generate QR Code","action":"Generate a QR code utility","resources":["utility"]},{"type":"operation","operation":"validateEmail","name":"Validate Email","action":"Validate an email address","resources":["utility"]}]


node_type: openAi
package_name: n8n-nodes-base
display_name: OpenAI
description: Consume Open AI
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"openAiApi","required":true}]
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Chat","value":"chat"},{"name":"Image","value":"image"},{"name":"Text","value":"text"}],"default":"text"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["chat"]}},"options":[{"name":"Complete","value":"complete","action":"Create a Completion","description":"Create one or more completions for a given text","routing":{"request":{"method":"POST","url":"/v1/chat/completions"},"output":{"postReceive":[null]}}}],"default":"complete"},{"displayName":"Model","name":"model","type":"options","description":"The model which will generate the completion. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.","displayOptions":{"show":{"operation":["complete"],"resource":["chat"]}},"typeOptions":{"loadOptions":{"routing":{"request":{"method":"GET","url":"/v1/models"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"data"}},{"type":"filter","properties":{"pass":"={{ $responseItem.id.startsWith('gpt-') }}"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.id}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"routing":{"send":{"type":"body","property":"model"}},"default":"gpt-3.5-turbo"},{"displayName":"Prompt","name":"prompt","type":"fixedCollection","typeOptions":{"sortable":true,"multipleValues":true},"displayOptions":{"show":{"resource":["chat"],"operation":["complete"]}},"placeholder":"Add Message","default":{},"options":[{"displayName":"Messages","name":"messages","values":[{"displayName":"Role","name":"role","type":"options","options":[{"name":"Assistant","value":"assistant"},{"name":"System","value":"system"},{"name":"User","value":"user"}],"default":"user"},{"displayName":"Content","name":"content","type":"string","default":""}]}],"routing":{"send":{"type":"body","property":"messages","value":"={{ $value.messages }}"}}},{"displayName":"Simplify","name":"simplifyOutput","type":"boolean","default":true,"displayOptions":{"show":{"operation":["complete"],"resource":["chat"]}},"routing":{"output":{"postReceive":[{"type":"set","enabled":"={{$value}}","properties":{"value":"={{ { \"data\": $response.body.choices } }}"}},{"type":"rootProperty","enabled":"={{$value}}","properties":{"property":"data"}},null]}},"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","placeholder":"Add Option","description":"Additional options to add","type":"collection","default":{},"displayOptions":{"show":{"operation":["complete"],"resource":["chat"]}},"options":[{"displayName":"Echo Prompt","name":"echo","type":"boolean","description":"Whether the prompt should be echo back in addition to the completion","default":false,"displayOptions":{"show":{"/operation":["complete"]}},"routing":{"send":{"type":"body","property":"echo"}}},{"displayName":"Frequency Penalty","name":"frequency_penalty","default":0,"typeOptions":{"maxValue":2,"minValue":-2,"numberPrecision":1},"description":"Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim","type":"number","routing":{"send":{"type":"body","property":"frequency_penalty"}}},{"displayName":"Maximum Number of Tokens","name":"maxTokens","default":16,"description":"The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).","type":"number","displayOptions":{"show":{"/operation":["complete"]}},"typeOptions":{"maxValue":32768},"routing":{"send":{"type":"body","property":"max_tokens"}}},{"displayName":"Number of Completions","name":"n","default":1,"description":"How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.","type":"number","routing":{"send":{"type":"body","property":"n"}}},{"displayName":"Presence Penalty","name":"presence_penalty","default":0,"typeOptions":{"maxValue":2,"minValue":-2,"numberPrecision":1},"description":"Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics","type":"number","routing":{"send":{"type":"body","property":"presence_penalty"}}},{"displayName":"Sampling Temperature","name":"temperature","default":1,"typeOptions":{"maxValue":1,"minValue":0,"numberPrecision":1},"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","routing":{"send":{"type":"body","property":"temperature"}}},{"displayName":"Top P","name":"topP","default":1,"typeOptions":{"maxValue":1,"minValue":0,"numberPrecision":1},"description":"Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.","type":"number","routing":{"send":{"type":"body","property":"top_p"}}}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["image"]}},"options":[{"name":"Create","value":"create","action":"Create an Image","description":"Create an image for a given text","routing":{"request":{"method":"POST","url":"/v1/images/generations"},"output":{"postReceive":[null]}}}],"routing":{"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"data"}}]}},"default":"create"},{"displayName":"Prompt","name":"prompt","type":"string","placeholder":"e.g. A cute cat eating a dinosaur","description":"A text description of the desired image(s). The maximum length is 1000 characters.","displayOptions":{"show":{"resource":["image"],"operation":["create"]}},"default":"","routing":{"send":{"type":"body","property":"prompt"}}},{"displayName":"Response Format","name":"responseFormat","type":"options","default":"binaryData","description":"The format in which to return the image(s)","displayOptions":{"show":{"resource":["image"],"operation":["create"]}},"options":[{"name":"Binary Data","value":"binaryData"},{"name":"Image Url","value":"imageUrl"}],"routing":{"send":{"type":"body","property":"response_format","value":"={{ $value === \"imageUrl\" ? \"url\" : \"b64_json\" }}"},"output":{"postReceive":[null]}}},{"displayName":"Options","name":"options","placeholder":"Add Option","description":"Additional options to add","type":"collection","default":{},"displayOptions":{"show":{"resource":["image"],"operation":["create"]}},"options":[{"displayName":"Number of Images","name":"n","default":1,"description":"Number of images to generate","type":"number","typeOptions":{"minValue":1,"maxValue":10},"routing":{"send":{"type":"body","property":"n"}}},{"displayName":"Resolution","name":"size","type":"options","options":[{"name":"256x256","value":"256x256"},{"name":"512x512","value":"512x512"},{"name":"1024x1024","value":"1024x1024"}],"routing":{"send":{"type":"body","property":"size"}},"default":"1024x1024"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["text"]}},"options":[{"name":"Complete","value":"complete","action":"Create a Completion","description":"Create one or more completions for a given text","routing":{"request":{"method":"POST","url":"/v1/completions"},"output":{"postReceive":[null]}}},{"name":"Edit","value":"edit","action":"Create an Edit","description":"Create an edited version for a given text","routing":{"request":{"method":"POST","url":"/v1/edits"},"output":{"postReceive":[null]}}},{"name":"Moderate","value":"moderate","action":"Create a Moderation","description":"Classify if a text violates OpenAI's content policy","routing":{"request":{"method":"POST","url":"/v1/moderations"},"output":{"postReceive":[null]}}}],"default":"complete"},{"displayName":"Model","name":"model","type":"options","description":"The model which will generate the completion. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.","displayOptions":{"show":{"operation":["complete"],"resource":["text"]}},"typeOptions":{"loadOptions":{"routing":{"request":{"method":"GET","url":"/v1/models"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"data"}},{"type":"filter","properties":{"pass":"={{ !$responseItem.id.startsWith('audio-') && !$responseItem.id.startsWith('gpt-') && !$responseItem.id.startsWith('whisper-') && !['cushman:2020-05-03', 'davinci-if:3.0.0', 'davinci-instruct-beta:2.0.0', 'if'].includes($responseItem.id) && !$responseItem.id.includes('-edit-') && !$responseItem.id.endsWith(':001') }}"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.id}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}},"routing":{"send":{"type":"body","property":"model"}},"default":"text-davinci-003"},{"displayName":"Prompt","name":"prompt","type":"string","description":"The prompt to generate completion(s) for","placeholder":"e.g. Say this is a test","displayOptions":{"show":{"resource":["text"],"operation":["complete"]}},"default":"","typeOptions":{"rows":2},"routing":{"send":{"type":"body","property":"prompt"}}},{"displayName":"Model","name":"model","type":"options","description":"The model which will generate the edited version. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.","displayOptions":{"show":{"operation":["edit"],"resource":["text"]}},"options":[{"name":"code-davinci-edit-001","value":"code-davinci-edit-001"},{"name":"text-davinci-edit-001","value":"text-davinci-edit-001"}],"routing":{"send":{"type":"body","property":"model"}},"default":"text-davinci-edit-001"},{"displayName":"Input","name":"input","type":"string","placeholder":"e.g. What day of the wek is it?","description":"The input text to be edited","displayOptions":{"show":{"resource":["text"],"operation":["edit"]}},"default":"","routing":{"send":{"type":"body","property":"input"}}},{"displayName":"Instruction","name":"instruction","type":"string","placeholder":"e.g. Fix the spelling mistakes","description":"The instruction that tells the model how to edit the input text","displayOptions":{"show":{"resource":["text"],"operation":["edit"]}},"default":"","routing":{"send":{"type":"body","property":"instruction"}}},{"displayName":"Model","name":"model","type":"options","description":"The model which will classify the text. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.","displayOptions":{"show":{"resource":["text"],"operation":["moderate"]}},"options":[{"name":"text-moderation-stable","value":"text-moderation-stable"},{"name":"text-moderation-latest","value":"text-moderation-latest"}],"routing":{"send":{"type":"body","property":"model"}},"default":"text-moderation-latest"},{"displayName":"Input","name":"input","type":"string","placeholder":"e.g. My cat is adorable ❤️❤️","description":"The input text to classify","displayOptions":{"show":{"resource":["text"],"operation":["moderate"]}},"default":"","routing":{"send":{"type":"body","property":"input"}}},{"displayName":"Simplify","name":"simplifyOutput","type":"boolean","default":true,"displayOptions":{"show":{"operation":["moderate"],"resource":["text"]}},"routing":{"output":{"postReceive":[{"type":"set","enabled":"={{$value}}","properties":{"value":"={{ { \"data\": $response.body.results } }}"}},{"type":"rootProperty","enabled":"={{$value}}","properties":{"property":"data"}}]}},"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Simplify","name":"simplifyOutput","type":"boolean","default":true,"displayOptions":{"show":{"operation":["complete","edit"],"resource":["text"]}},"routing":{"output":{"postReceive":[{"type":"set","enabled":"={{$value}}","properties":{"value":"={{ { \"data\": $response.body.choices } }}"}},{"type":"rootProperty","enabled":"={{$value}}","properties":{"property":"data"}},null]}},"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","placeholder":"Add Option","description":"Additional options to add","type":"collection","default":{},"displayOptions":{"show":{"operation":["complete","edit"],"resource":["text"]}},"options":[{"displayName":"Echo Prompt","name":"echo","type":"boolean","description":"Whether the prompt should be echo back in addition to the completion","default":false,"displayOptions":{"show":{"/operation":["complete"]}},"routing":{"send":{"type":"body","property":"echo"}}},{"displayName":"Frequency Penalty","name":"frequency_penalty","default":0,"typeOptions":{"maxValue":2,"minValue":-2,"numberPrecision":1},"description":"Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim","type":"number","routing":{"send":{"type":"body","property":"frequency_penalty"}}},{"displayName":"Maximum Number of Tokens","name":"maxTokens","default":16,"description":"The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).","type":"number","displayOptions":{"show":{"/operation":["complete"]}},"typeOptions":{"maxValue":32768},"routing":{"send":{"type":"body","property":"max_tokens"}}},{"displayName":"Number of Completions","name":"n","default":1,"description":"How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.","type":"number","routing":{"send":{"type":"body","property":"n"}}},{"displayName":"Presence Penalty","name":"presence_penalty","default":0,"typeOptions":{"maxValue":2,"minValue":-2,"numberPrecision":1},"description":"Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics","type":"number","routing":{"send":{"type":"body","property":"presence_penalty"}}},{"displayName":"Sampling Temperature","name":"temperature","default":1,"typeOptions":{"maxValue":1,"minValue":0,"numberPrecision":1},"description":"Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.","type":"number","routing":{"send":{"type":"body","property":"temperature"}}},{"displayName":"Top P","name":"topP","default":1,"typeOptions":{"maxValue":1,"minValue":0,"numberPrecision":1},"description":"Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.","type":"number","routing":{"send":{"type":"body","property":"top_p"}}}]}]

operations:
  [{"type":"resource","resource":"chat","name":"Chat"},{"type":"resource","resource":"image","name":"Image"},{"type":"resource","resource":"text","name":"Text"},{"type":"operation","operation":"complete","name":"Complete","action":"Create a Completion","resources":["chat"]},{"type":"operation","operation":"create","name":"Create","action":"Create an Image","resources":["image"]},{"type":"operation","operation":"complete","name":"Complete","action":"Create a Completion","resources":["text"]},{"type":"operation","operation":"edit","name":"Edit","action":"Create an Edit","resources":["text"]},{"type":"operation","operation":"moderate","name":"Moderate","action":"Create a Moderation","resources":["text"]}]


node_type: openThesaurus
package_name: n8n-nodes-base
display_name: OpenThesaurus
description: Get synonmns for German words using the OpenThesaurus API
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: OpenThesaurus node documentation
  description: Learn how to use the OpenThesaurus node in n8n. Follow technical documentation to integrate OpenThesaurus node into your workflows.
  contentType: [integration, reference]
  ---

  # OpenThesaurus node

  Use the OpenThesaurus node to automate work in OpenThesaurus, and integrate OpenThesaurus with other applications. n8n supports synonym look-up for German words. 

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

  /// note | Credentials
  OpenThesaurus node doesn't require authentication. 
  ///

  ## Operations

  * Get synonyms for a German word in German

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Get Synonyms","value":"getSynonyms","description":"Get synonyms for a German word in German","action":"Get synonyms"}],"default":"getSynonyms"},{"displayName":"Text","name":"text","type":"string","default":"","description":"The word to get synonyms for","required":true,"displayOptions":{"show":{"operation":["getSynonyms"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Options","displayOptions":{"show":{"operation":["getSynonyms"]}},"default":{},"options":[{"displayName":"Baseform","name":"baseform","type":"boolean","default":false,"description":"Specifies the basic form for the search term if it is not already a basic form"},{"displayName":"Similar","name":"similar","type":"boolean","default":false,"description":"This also returns up to five similarly written words for each answer. This is useful to be able to make a suggestion to the user in the event of a possible typing error."},{"displayName":"Starts With","name":"startswith","type":"boolean","default":false,"description":"Like substring = true, but only finds words that begin with the specified search term"},{"displayName":"Substring","name":"substring","type":"boolean","default":false,"description":"Whether up to ten words are returned for each answer that only contain the search term as a partial word"},{"displayName":"Substring From Results","name":"substringFromResults","type":"number","default":0,"description":"Specifies from which entry the partial word hits are to be returned. Only works together with substring = true."},{"displayName":"Substring Max Results","name":"substringMaxResults","type":"number","typeOptions":{"maxValue":250},"default":10,"description":"Specifies how many partial word hits should be returned in total. Only works together with substring = true."},{"displayName":"Subsynsets","name":"subsynsets","type":"boolean","default":false,"description":"Whether each synonym group has its (optional) sub-terms supplied"},{"displayName":"Supersynsets","name":"supersynsets","type":"boolean","default":false,"description":"Whether each synonym group is supplied with its (optional) generic terms"}]}]


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

  # OpenWeatherMap node

  Use the OpenWeatherMap node to automate work in OpenWeatherMap, and integrate OpenWeatherMap with other applications. n8n supports retrieving current and upcoming weather data with OpenWeatherMap.

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

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

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

  ## Operations

  * Returns the current weather data
  * Returns the weather data for the next 5 days

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Current Weather","value":"currentWeather","description":"Returns the current weather data","action":"Return current weather data"},{"name":"5 Day Forecast","value":"5DayForecast","description":"Returns the weather data for the next 5 days","action":"Return weather data for the next 5 days"}],"default":"currentWeather"},{"displayName":"Format","name":"format","type":"options","options":[{"name":"Imperial","value":"imperial","description":"Fahrenheit | miles/hour"},{"name":"Metric","value":"metric","description":"Celsius | meter/sec"},{"name":"Scientific","value":"standard","description":"Kelvin | meter/sec"}],"default":"metric","description":"The format in which format the data should be returned"},{"displayName":"Location Selection","name":"locationSelection","type":"options","options":[{"name":"City Name","value":"cityName"},{"name":"City ID","value":"cityId"},{"name":"Coordinates","value":"coordinates"},{"name":"Zip Code","value":"zipCode"}],"default":"cityName","description":"How to define the location for which to return the weather"},{"displayName":"City","name":"cityName","type":"string","default":"","placeholder":"berlin,de","required":true,"displayOptions":{"show":{"locationSelection":["cityName"]}},"description":"The name of the city to return the weather of"},{"displayName":"City ID","name":"cityId","type":"number","default":160001123,"required":true,"displayOptions":{"show":{"locationSelection":["cityId"]}},"description":"The ID of city to return the weather of. List can be downloaded here: http://bulk.openweathermap.org/sample/."},{"displayName":"Latitude","name":"latitude","type":"string","default":"","placeholder":"13.39","required":true,"displayOptions":{"show":{"locationSelection":["coordinates"]}},"description":"The latitude of the location to return the weather of"},{"displayName":"Longitude","name":"longitude","type":"string","default":"","placeholder":"52.52","required":true,"displayOptions":{"show":{"locationSelection":["coordinates"]}},"description":"The longitude of the location to return the weather of"},{"displayName":"Zip Code","name":"zipCode","type":"string","default":"","placeholder":"10115,de","required":true,"displayOptions":{"show":{"locationSelection":["zipCode"]}},"description":"The ID of city to return the weather of. List can be downloaded here: http://bulk.openweathermap.org/sample/."},{"displayName":"Language","name":"language","type":"string","default":"","placeholder":"en","description":"The two letter language code to get your output in (eg. en, de, ...)."}]


node_type: orbit
package_name: n8n-nodes-base
display_name: Orbit
description: Consume Orbit API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"orbitApi","required":true}]
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Activity","value":"activity"},{"name":"Member","value":"member"},{"name":"Note","value":"note"},{"name":"Post","value":"post"}],"default":"member"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["activity"]}},"options":[{"name":"Create","value":"create","description":"Create an activity for a member","action":"Create an activity"},{"name":"Get Many","value":"getAll","description":"Get many activities","action":"Get many activities"}],"default":"create"},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Title","name":"title","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"default":{},"options":[{"displayName":"Activity Type Name or ID","name":"activityType","type":"options","typeOptions":{"loadOptionsMethod":"getActivityTypes"},"default":"","description":"A user-defined way to group activities of the same nature. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Description","name":"description","type":"string","default":"","description":"A description of the activity; displayed in the timeline"},{"displayName":"Key","name":"key","type":"string","default":"","description":"Supply a key that must be unique or leave blank to have one generated"},{"displayName":"Link","name":"link","type":"string","default":"","description":"A URL for the activity; displayed in the timeline"},{"displayName":"Link Text","name":"linkText","type":"string","default":"","description":"The text for the timeline link"},{"displayName":"Occurred At","name":"occurredAt","type":"dateTime","default":"","description":"The date and time the activity occurred; defaults to now"}]},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["activity"]}},"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":["activity"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}},"options":[{"displayName":"Member ID","name":"memberId","type":"string","default":"","description":"When set the post will be filtered by the member ID"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["member"]}},"options":[{"name":"Create or Update","value":"upsert","description":"Create a new member, or update the current one if it already exists (upsert)","action":"Create or update a member"},{"name":"Delete","value":"delete","description":"Delete a member","action":"Delete a member"},{"name":"Get","value":"get","description":"Get a member","action":"Get a member"},{"name":"Get Many","value":"getAll","description":"Get many members in a workspace","action":"Get many members"},{"name":"Lookup","value":"lookup","description":"Lookup a member by identity","action":"Lookup a member"},{"name":"Update","value":"update","description":"Update a member","action":"Update a member"}],"default":"get"},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["delete"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["delete"]}}},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["get"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["get"]}}},{"displayName":"Resolve Identities","name":"resolveIdentities","type":"boolean","displayOptions":{"show":{"operation":["get"],"resource":["member"]}},"default":false,"description":"By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically."},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["getAll"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["member"]}},"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":["member"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Resolve Identities","name":"resolveIdentities","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["member"]}},"default":false,"description":"By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["member"],"operation":["getAll"]}},"options":[{"displayName":"Sort By","name":"sort","type":"string","default":"","description":"Name of the field the response will be sorted by"},{"displayName":"Sort Direction","name":"direction","type":"options","options":[{"name":"ASC","value":"ASC"},{"name":"DESC","value":"DESC"}],"default":""}]},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"]}}},{"displayName":"Source","name":"source","type":"options","options":[{"name":"Discourse","value":"discourse"},{"name":"Email","value":"email"},{"name":"GitHub","value":"github"},{"name":"Twitter","value":"twitter"}],"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"]}},"description":"Set to github, twitter, email, discourse or the source of any identities you've manually created"},{"displayName":"Search By","name":"searchBy","type":"options","options":[{"name":"Username","value":"username"},{"name":"ID","value":"id"}],"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"],"source":["discourse","github","twitter"]}}},{"displayName":"ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"],"searchBy":["id"],"source":["discourse","github","twitter"]}},"description":"The username at the source"},{"displayName":"Username","name":"username","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"],"searchBy":["username"],"source":["discourse","github","twitter"]}},"description":"The username at the source"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"],"source":["email"]}},"description":"The email address"},{"displayName":"Host","name":"host","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["lookup"],"source":["discourse"]}}},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["update"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["member"],"operation":["update"]}},"default":{},"options":[{"displayName":"Bio","name":"bio","type":"string","default":""},{"displayName":"Birthday","name":"birthday","type":"dateTime","default":""},{"displayName":"Company","name":"company","type":"string","default":""},{"displayName":"Location","name":"location","type":"string","default":""},{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Pronouns","name":"pronouns","type":"string","default":""},{"displayName":"Shipping Address","name":"shippingAddress","type":"string","default":""},{"displayName":"Slug","name":"slug","type":"string","default":""},{"displayName":"Tags to Add","name":"tagsToAdd","type":"string","default":"","description":"Adds tags to member; comma-separated string or array"},{"displayName":"Tag List","name":"tagList","type":"string","default":"","description":"Replaces all tags for the member; comma-separated string or array"},{"displayName":"T-Shirt","name":"tShirt","type":"string","default":""},{"displayName":"Teammate","name":"teammate","type":"boolean","default":false},{"displayName":"URL","name":"url","type":"string","default":""}]},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["member"],"operation":["upsert"]}}},{"displayName":"Identity","name":"identityUi","type":"fixedCollection","description":"The identity is used to find the member. If no member exists, a new member will be created and linked to the provided identity.","typeOptions":{"multipleValues":false},"placeholder":"Add Identity","default":{},"displayOptions":{"show":{"resource":["member"],"operation":["upsert"]}},"options":[{"displayName":"Identity","name":"identityValue","values":[{"displayName":"Source","name":"source","type":"options","options":[{"name":"Discourse","value":"discourse"},{"name":"Email","value":"email"},{"name":"GitHub","value":"github"},{"name":"Twitter","value":"twitter"}],"default":"","description":"Set to github, twitter, email, discourse or the source of any identities you've manually created"},{"displayName":"Search By","name":"searchBy","type":"options","options":[{"name":"Username","value":"username"},{"name":"ID","value":"id"}],"default":"","required":true,"displayOptions":{"show":{"source":["discourse","github","twitter"]}}},{"displayName":"ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"searchBy":["id"],"source":["discourse","github","twitter"]}},"description":"The username at the source"},{"displayName":"Username","name":"username","type":"string","default":"","required":true,"displayOptions":{"show":{"searchBy":["username"],"source":["discourse","github","twitter"]}},"description":"The username at the source"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","required":true,"displayOptions":{"show":{"source":["email"]}}},{"displayName":"Host","name":"host","type":"string","default":"","required":true,"displayOptions":{"show":{"source":["discourse"]}}}]}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["member"],"operation":["upsert"]}},"default":{},"options":[{"displayName":"Bio","name":"bio","type":"string","default":""},{"displayName":"Birthday","name":"birthday","type":"dateTime","default":""},{"displayName":"Company","name":"company","type":"string","default":""},{"displayName":"Location","name":"location","type":"string","default":""},{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Pronouns","name":"pronouns","type":"string","default":""},{"displayName":"Shipping Address","name":"shippingAddress","type":"string","default":""},{"displayName":"Slug","name":"slug","type":"string","default":""},{"displayName":"Tags to Add","name":"tagsToAdd","type":"string","default":"","description":"Adds tags to member; comma-separated string or array"},{"displayName":"Tag List","name":"tagList","type":"string","default":"","description":"Replaces all tags for the member; comma-separated string or array"},{"displayName":"T-Shirt","name":"tShirt","type":"string","default":""},{"displayName":"Teammate","name":"teammate","type":"boolean","default":false},{"displayName":"URL","name":"url","type":"string","default":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["note"]}},"options":[{"name":"Create","value":"create","description":"Create a note","action":"Create a note"},{"name":"Get Many","value":"getAll","description":"Get many notes for a member","action":"Get many notes"},{"name":"Update","value":"update","description":"Update a note","action":"Update a note"}],"default":"create"},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["create"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["create"]}}},{"displayName":"Note","name":"note","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["create"]}}},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["getAll"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["getAll"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["note"]}},"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":["note"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Resolve Member","name":"resolveMember","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["note"]}},"default":false},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["update"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["update"]}}},{"displayName":"Note ID","name":"noteId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["update"]}}},{"displayName":"Note","name":"note","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["note"],"operation":["update"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["post"]}},"options":[{"name":"Create","value":"create","description":"Create a post","action":"Create a post"},{"name":"Get Many","value":"getAll","description":"Get many posts","action":"Get many posts"},{"name":"Delete","value":"delete","description":"Delete a post","action":"Delete a post"}],"default":"create"},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["create"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["create"]}}},{"displayName":"URL","name":"url","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["create"]}},"description":"Supply any URL and Orbit will do its best job to parse out a title, description, and image"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["post"],"operation":["create"]}},"default":{},"options":[{"displayName":"Occurred At","name":"publishedAt","type":"dateTime","default":""}]},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["getAll"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["post"]}},"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":["post"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["post"],"operation":["getAll"]}},"options":[{"displayName":"Member ID","name":"memberId","type":"string","default":"","description":"When set the post will be filtered by the member ID"}]},{"displayName":"Workspace Name or ID","name":"workspaceId","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":"getWorkspaces"},"default":"","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["delete"]}}},{"displayName":"Member ID","name":"memberId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["post"],"operation":["delete"]}}},{"displayName":"Post ID","name":"postId","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["post"]}}}]

operations:
  [{"type":"resource","resource":"activity","name":"Activity"},{"type":"resource","resource":"member","name":"Member"},{"type":"resource","resource":"note","name":"Note"},{"type":"resource","resource":"post","name":"Post"},{"type":"operation","operation":"create","name":"Create","action":"Create an activity","resources":["activity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many activities","resources":["activity"]},{"type":"operation","operation":"upsert","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":"get","name":"Get","action":"Get a member","resources":["member"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many members","resources":["member"]},{"type":"operation","operation":"lookup","name":"Lookup","action":"Lookup 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":"getAll","name":"Get Many","action":"Get many notes","resources":["note"]},{"type":"operation","operation":"update","name":"Update","action":"Update a note","resources":["note"]},{"type":"operation","operation":"create","name":"Create","action":"Create a post","resources":["post"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many posts","resources":["post"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a post","resources":["post"]}]


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

  # Oura node

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

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

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

  ## Operations

  * Profile
      * Get the user's personal information.
  * Summary
      * Get the user's activity summary.
      * Get the user's readiness summary.
      * Get the user's sleep summary

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Profile","value":"profile"},{"name":"Summary","value":"summary"}],"default":"summary"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["profile"]}},"options":[{"name":"Get","value":"get","description":"Get the user's personal information","action":"Get a profile"}],"default":"get"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["summary"]}},"options":[{"name":"Get Activity Summary","value":"getActivity","description":"Get the user's activity summary","action":"Get activity summary"},{"name":"Get Readiness Summary","value":"getReadiness","description":"Get the user's readiness summary","action":"Get readiness summary"},{"name":"Get Sleep Periods","value":"getSleep","description":"Get the user's sleep summary","action":"Get sleep summary"}],"default":"getSleep"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["summary"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["summary"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":10},"default":5,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","displayOptions":{"show":{"resource":["summary"]}},"default":{},"options":[{"displayName":"End Date","name":"end","type":"dateTime","default":"","description":"End date for the summary retrieval. If omitted, it defaults to the current day."},{"displayName":"Start Date","name":"start","type":"dateTime","default":"","description":"Start date for the summary retrieval. If omitted, it defaults to a week ago."}]}]

operations:
  [{"type":"resource","resource":"profile","name":"Profile"},{"type":"resource","resource":"summary","name":"Summary"},{"type":"operation","operation":"get","name":"Get","action":"Get a profile","resources":["profile"]},{"type":"operation","operation":"getActivity","name":"Get Activity Summary","action":"Get activity summary","resources":["summary"]},{"type":"operation","operation":"getReadiness","name":"Get Readiness Summary","action":"Get readiness summary","resources":["summary"]},{"type":"operation","operation":"getSleep","name":"Get Sleep Periods","action":"Get sleep summary","resources":["summary"]}]


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

  # Paddle node

  Use the Paddle node to automate work in Paddle, and integrate Paddle with other applications. n8n has built-in support for a wide range of Paddle features, including creating, updating, and getting coupons, as well as getting plans, products, and users. 

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

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

  ## Operations

  * Coupon
      * Create a coupon.
      * Get all coupons.
      * Update a coupon.
  * Payment
      * Get all payment.
      * Reschedule payment.
  * Plan
      * Get a plan.
      * Get all plans.
  * Product
      * Get all products.
  * User
      * Get all users

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Coupon","value":"coupon"},{"name":"Payment","value":"payment"},{"name":"Plan","value":"plan"},{"name":"Product","value":"product"},{"name":"User","value":"user"}],"default":"coupon"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["coupon"]}},"options":[{"name":"Create","value":"create","description":"Create a coupon","action":"Create a coupon"},{"name":"Get Many","value":"getAll","description":"Get many coupons","action":"Get many coupons"},{"name":"Update","value":"update","description":"Update a coupon","action":"Update a coupon"}],"default":"create"},{"displayName":"Coupon Type","name":"couponType","type":"options","displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"jsonParameters":[false]}},"default":"checkout","description":"Either product (valid for specified products or subscription plans) or checkout (valid for any checkout)","options":[{"name":"Checkout","value":"checkout"},{"name":"Product","value":"product"}]},{"displayName":"Product Names or IDs","name":"productIds","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getProducts"},"displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"couponType":["product"],"jsonParameters":[false]}},"default":[],"description":"Comma-separated list of product IDs. Required if coupon_type is product. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","required":true},{"displayName":"Discount Type","name":"discountType","type":"options","displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"jsonParameters":[false]}},"default":"flat","description":"Either flat or percentage","options":[{"name":"Flat","value":"flat"},{"name":"Percentage","value":"percentage"}]},{"displayName":"Discount Amount Currency","name":"discountAmount","type":"number","default":1,"description":"Discount amount in currency","typeOptions":{"minValue":1},"displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"discountType":["flat"],"jsonParameters":[false]}}},{"displayName":"Discount Amount %","name":"discountAmount","type":"number","default":1,"description":"Discount amount in percentage","typeOptions":{"minValue":1,"maxValue":100},"displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"discountType":["percentage"],"jsonParameters":[false]}}},{"displayName":"Currency","name":"currency","type":"options","default":"EUR","description":"The currency must match the balance currency specified in your account","options":[{"name":"ARS","value":"ARS"},{"name":"AUD","value":"AUD"},{"name":"BRL","value":"BRL"},{"name":"CAD","value":"CAD"},{"name":"CHF","value":"CHF"},{"name":"CNY","value":"CNY"},{"name":"CZK","value":"CZK"},{"name":"DKK","value":"DKK"},{"name":"EUR","value":"EUR"},{"name":"GBP","value":"GBP"},{"name":"HKD","value":"HKD"},{"name":"HUF","value":"HUF"},{"name":"INR","value":"INR"},{"name":"JPY","value":"JPY"},{"name":"KRW","value":"KRW"},{"name":"MXN","value":"MXN"},{"name":"NOK","value":"NOK"},{"name":"NZD","value":"NZD"},{"name":"PLN","value":"PLN"},{"name":"RUB","value":"RUB"},{"name":"SEK","value":"SEK"},{"name":"SGD","value":"SGD"},{"name":"THB","value":"THB"},{"name":"TWD","value":"TWD"},{"name":"USD","value":"USD"},{"name":"ZAR","value":"ZAR"}],"displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"discountType":["flat"],"jsonParameters":[false]}}},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["coupon"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"jsonParameters":[true]}},"description":"Attributes in JSON form"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["coupon"],"operation":["create"],"jsonParameters":[false]}},"default":{},"options":[{"displayName":"Allowed Uses","name":"allowedUses","type":"number","default":1,"description":"Number of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specified."},{"displayName":"Coupon Code","name":"couponCode","type":"string","default":"","description":"Will be randomly generated if not specified"},{"displayName":"Coupon Prefix","name":"couponPrefix","type":"string","default":"","description":"Prefix for generated codes. Not valid if coupon_code is specified."},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the coupon. This will be displayed in the Seller Dashboard."},{"displayName":"Expires","name":"expires","type":"dateTime","default":"","description":"The coupon will expire on the date at 00:00:00 UTC"},{"displayName":"Group","name":"group","type":"string","typeOptions":{"minValue":1,"maxValue":50},"default":"","description":"The name of the coupon group this coupon should be assigned to"},{"displayName":"Number of Coupons","name":"numberOfCoupons","type":"number","default":1,"description":"Number of coupons to generate. Not valid if coupon_code is specified."},{"displayName":"Recurring","name":"recurring","type":"boolean","default":false,"description":"If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchase"}]},{"displayName":"Product ID","name":"productId","type":"string","displayOptions":{"show":{"resource":["coupon"],"operation":["getAll"]}},"default":"","required":true,"description":"The specific product/subscription ID"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["coupon"]}},"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":["coupon"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Update By","name":"updateBy","type":"options","displayOptions":{"show":{"resource":["coupon"],"operation":["update"],"jsonParameters":[false]}},"default":"couponCode","description":"Either flat or percentage","options":[{"name":"Coupon Code","value":"couponCode"},{"name":"Group","value":"group"}]},{"displayName":"Coupon Code","name":"couponCode","type":"string","displayOptions":{"show":{"resource":["coupon"],"operation":["update"],"updateBy":["couponCode"],"jsonParameters":[false]}},"default":"","description":"Identify the coupon to update"},{"displayName":"Group","name":"group","type":"string","displayOptions":{"show":{"resource":["coupon"],"operation":["update"],"updateBy":["group"],"jsonParameters":[false]}},"default":"","description":"The name of the group of coupons you want to update"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["coupon"],"operation":["update"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["coupon"],"operation":["update"],"jsonParameters":[true]}},"description":"Attributes in JSON form"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["coupon"],"operation":["update"],"jsonParameters":[false]}},"default":{},"options":[{"displayName":"Allowed Uses","name":"allowedUses","type":"number","default":1,"description":"Number of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specified."},{"displayName":"Discount","name":"discount","type":"fixedCollection","default":{},"options":[{"displayName":"Discount Properties","name":"discountProperties","values":[{"displayName":"Currency","name":"currency","type":"options","default":"EUR","description":"The currency must match the balance currency specified in your account","displayOptions":{"show":{"discountType":["flat"]}},"options":[{"name":"ARS","value":"ARS"},{"name":"AUD","value":"AUD"},{"name":"BRL","value":"BRL"},{"name":"CAD","value":"CAD"},{"name":"CHF","value":"CHF"},{"name":"CNY","value":"CNY"},{"name":"CZK","value":"CZK"},{"name":"DKK","value":"DKK"},{"name":"EUR","value":"EUR"},{"name":"GBP","value":"GBP"},{"name":"HKD","value":"HKD"},{"name":"HUF","value":"HUF"},{"name":"INR","value":"INR"},{"name":"JPY","value":"JPY"},{"name":"KRW","value":"KRW"},{"name":"MXN","value":"MXN"},{"name":"NOK","value":"NOK"},{"name":"NZD","value":"NZD"},{"name":"PLN","value":"PLN"},{"name":"RUB","value":"RUB"},{"name":"SEK","value":"SEK"},{"name":"SGD","value":"SGD"},{"name":"THB","value":"THB"},{"name":"TWD","value":"TWD"},{"name":"USD","value":"USD"},{"name":"ZAR","value":"ZAR"}]},{"displayName":"Discount Amount Currency","name":"discountAmount","type":"number","default":"","description":"Discount amount","displayOptions":{"show":{"discountType":["flat"]}},"typeOptions":{"minValue":0}},{"displayName":"Discount Amount Percentage","name":"discountAmount","type":"number","default":"","description":"Discount amount","displayOptions":{"show":{"discountType":["percentage"]}},"typeOptions":{"minValue":0,"maxValue":100}},{"displayName":"Discount Type","name":"discountType","type":"options","default":"flat","description":"Either flat or percentage","options":[{"name":"Flat","value":"flat"},{"name":"Percentage","value":"percentage"}]}]}]},{"displayName":"Expires","name":"expires","type":"dateTime","default":"","description":"The coupon will expire on the date at 00:00:00 UTC"},{"displayName":"New Coupon Code","name":"newCouponCode","type":"string","default":"","description":"New code to rename the coupon to"},{"displayName":"New Group Name","name":"newGroup","type":"string","typeOptions":{"minValue":1,"maxValue":50},"default":"","description":"New group name to move coupon to"},{"displayName":"Product IDs","name":"productIds","type":"string","default":"","description":"Comma-separated list of products e.g. 499531,1234,123546. If blank then remove associated products."},{"displayName":"Recurring","name":"recurring","type":"boolean","default":false,"description":"If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchase"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["payment"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many payments","action":"Get many payments"},{"name":"Reschedule","value":"reschedule","description":"Reschedule payment","action":"Reschedule a payment"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["payment"]}},"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":["payment"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["payment"],"operation":["getAll"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["payment"],"operation":["getAll"],"jsonParameters":[true]}},"description":"Attributes in JSON form"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["payment"],"operation":["getAll"],"jsonParameters":[false]}},"default":{},"options":[{"displayName":"Date From","name":"from","type":"dateTime","default":"","description":"Payment starting from date"},{"displayName":"Date To","name":"to","type":"dateTime","default":"","description":"Payment up until date"},{"displayName":"Is Paid","name":"isPaid","type":"boolean","default":false,"description":"Whether payment is paid"},{"displayName":"Plan ID","name":"plan","type":"string","default":"","description":"Filter: The product/plan ID (single or comma-separated values)"},{"displayName":"Subscription ID","name":"subscriptionId","type":"number","default":"","description":"A specific user subscription ID"},{"displayName":"State","name":"state","type":"options","default":"active","description":"Filter: The user subscription status. Returns all active, past_due, trialing and paused subscription plans if not specified.","options":[{"name":"Active","value":"active"},{"name":"Past Due","value":"past_due"},{"name":"Paused","value":"paused"},{"name":"Trialing","value":"trialing"}]},{"displayName":"One Off Charge","name":"isOneOffCharge","type":"boolean","default":false}]},{"displayName":"Payment Name or ID","name":"paymentId","type":"options","typeOptions":{"loadOptionsMethod":"getPayments"},"default":"","required":true,"displayOptions":{"show":{"resource":["payment"],"operation":["reschedule"]}},"description":"The upcoming subscription payment ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Date","name":"date","type":"dateTime","default":"","displayOptions":{"show":{"resource":["payment"],"operation":["reschedule"]}},"description":"Date you want to move the payment to"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["plan"]}},"options":[{"name":"Get","value":"get","description":"Get a plan","action":"Get a plan"},{"name":"Get Many","value":"getAll","description":"Get many plans","action":"Get many plans"}],"default":"get"},{"displayName":"Plan ID","name":"planId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["plan"],"operation":["get"]}},"description":"Filter: The subscription plan ID"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["plan"]}},"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":["plan"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["product"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many products","action":"Get many products"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["product"]}},"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":["product"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many users","action":"Get many users"}],"default":"getAll"},{"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","default":100,"required":true,"typeOptions":{"minValue":1,"maxValue":200},"displayOptions":{"show":{"resource":["user"],"operation":["getAll"],"returnAll":[false]}},"description":"Max number of results to return"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}}},{"displayName":"Additional Fields","name":"additionalFieldsJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"resource":["user"],"operation":["getAll"],"jsonParameters":[true]}},"description":"Attributes in JSON form"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["user"],"operation":["getAll"],"jsonParameters":[false]}},"default":{},"options":[{"displayName":"Plan ID","name":"planId","type":"string","default":"","description":"Filter: The subscription plan ID"},{"displayName":"Subscription ID","name":"subscriptionId","type":"string","default":"","description":"A specific user subscription ID"},{"displayName":"State","name":"state","type":"options","default":"active","description":"Filter: The user subscription status. Returns all active, past_due, trialing and paused subscription plans if not specified.","options":[{"name":"Active","value":"active"},{"name":"Past Due","value":"past_due"},{"name":"Paused","value":"paused"},{"name":"Trialing","value":"trialing"}]}]}]

operations:
  [{"type":"resource","resource":"coupon","name":"Coupon"},{"type":"resource","resource":"payment","name":"Payment"},{"type":"resource","resource":"plan","name":"Plan"},{"type":"resource","resource":"product","name":"Product"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"create","name":"Create","action":"Create a coupon","resources":["coupon"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many coupons","resources":["coupon"]},{"type":"operation","operation":"update","name":"Update","action":"Update a coupon","resources":["coupon"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many payments","resources":["payment"]},{"type":"operation","operation":"reschedule","name":"Reschedule","action":"Reschedule a payment","resources":["payment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a plan","resources":["plan"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many plans","resources":["plan"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many products","resources":["product"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]}]


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

  # PagerDuty node

  Use the PagerDuty node to automate work in PagerDuty, and integrate PagerDuty with other applications. n8n has built-in support for a wide range of PagerDuty features, including creating incident notes, as well as updating, and getting all log entries and users. 

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

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

  ## Operations

  * Incident
      * Create an incident
      * Get an incident
      * Get all incidents
      * Update an incident
  * Incident Note
      * Create an incident note
      * Get all incident's notes
  * Log Entry
      * Get a log entry
      * Get all log entries
  * User
      * Get a user

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"API Token","value":"apiToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"apiToken"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Incident","value":"incident"},{"name":"Incident Note","value":"incidentNote"},{"name":"Log Entry","value":"logEntry"},{"name":"User","value":"user"}],"default":"incident"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["incident"]}},"options":[{"name":"Create","value":"create","description":"Create an incident","action":"Create an incident"},{"name":"Get","value":"get","description":"Get an incident","action":"Get an incident"},{"name":"Get Many","value":"getAll","description":"Get many incidents","action":"Get many incidents"},{"name":"Update","value":"update","description":"Update an incident","action":"Update an incident"}],"default":"create"},{"displayName":"Title","name":"title","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"description":"A succinct description of the nature, symptoms, cause, or effect of the incident"},{"displayName":"Service Name or ID","name":"serviceId","type":"options","typeOptions":{"loadOptionsMethod":"getServices"},"required":true,"default":"","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"description":"The incident will be created on this service. 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","required":true,"default":"","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"description":"The email address of a valid user associated with the account making the request"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"default":{},"options":[{"displayName":"Escalation Policy Name or ID","name":"escalationPolicyId","type":"options","typeOptions":{"loadOptionsMethod":"getEscalationPolicies"},"default":"","description":"Delegate this incident to the specified escalation policy. Cannot be specified if an assignee is given. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Incident Details","name":"details","type":"string","default":"","description":"Additional details about the incident which will go in the body"},{"displayName":"Incident Key","name":"incidentKey","type":"string","default":"","description":"Sending subsequent requests referencing the same service and with the same incident_key will result in those requests being rejected if an open incident matches that incident_key"},{"displayName":"Priority Name or ID","name":"priorityId","type":"options","typeOptions":{"loadOptionsMethod":"getPriorities"},"default":"","description":"The incident will be created on this service. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Urgency","name":"urgency","type":"options","options":[{"name":"Hight","value":"high"},{"name":"Low","value":"low"}],"default":"","description":"The urgency of the incident"}]},{"displayName":"Conference Bridge","name":"conferenceBridgeUi","type":"fixedCollection","typeOptions":{"multipleValues":false},"placeholder":"Add Conference Bridge","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"default":{},"options":[{"displayName":"Conference Bridge","name":"conferenceBridgeValues","values":[{"displayName":"Conference Number","name":"conferenceNumber","type":"string","default":"","description":"Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input"},{"displayName":"Conference URL","name":"conferenceUrl","type":"string","default":"","description":"An URL for the conference bridge. This could be a link to a web conference or Slack channel."}]}]},{"displayName":"Incident ID","name":"incidentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["incident"],"operation":["get"]}},"description":"Unique identifier for the incident"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["incident"]}},"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":["incident"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["incident"],"operation":["getAll"]}},"options":[{"displayName":"Date Range","name":"dateRange","type":"options","options":[{"name":"All","value":"all"}],"default":"","description":"When set to all, the since and until parameters and defaults are ignored"},{"displayName":"Incident Key","name":"incidentKey","type":"string","default":"","description":"Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key."},{"displayName":"Include","name":"include","type":"multiOptions","options":[{"name":"Acknowledgers","value":"acknowledgers"},{"name":"Assignees","value":"assignees"},{"name":"Conference Bridge","value":"conferenceBridge"},{"name":"Escalation Policies","value":"escalationPolicies"},{"name":"First Trigger Log Entries","value":"firstTriggerLogEntries"},{"name":"Priorities","value":"priorities"},{"name":"Services","value":"services"},{"name":"Teams","value":"teams"},{"name":"Users","value":"users"}],"default":[],"description":"Additional details to include"},{"displayName":"Service Names or IDs","name":"serviceIds","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getServices"},"default":[],"description":"Returns only the incidents associated with the passed service(s). Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Since","name":"since","type":"dateTime","default":"","description":"The start of the date range over which you want to search. (the limit on date ranges is 6 months)."},{"displayName":"Sort By","name":"sortBy","type":"string","default":"","placeholder":"created_at:asc,resolved_at:desc","description":"Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma."},{"displayName":"Statuses","name":"statuses","type":"multiOptions","options":[{"name":"Acknowledged","value":"acknowledged"},{"name":"Resolved","value":"resolved"},{"name":"Triggered","value":"triggered"}],"default":[],"description":"Returns only the incidents associated with the passed service(s)"},{"displayName":"Team IDs","name":"teamIds","type":"string","default":"","description":"Team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter. (multiples IDs can be added separated by comma)"},{"displayName":"Timezone Name or ID","name":"timeZone","type":"options","typeOptions":{"loadOptionsMethod":"getTimezones"},"default":"","description":"Time zone in which dates in the result will be rendered. If not set dates will return UTC. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Until","name":"until","type":"dateTime","default":"","description":"The end of the date range over which you want to search. (the limit on date ranges is 6 months)."},{"displayName":"Urgencies","name":"urgencies","type":"multiOptions","options":[{"name":"High","value":"high"},{"name":"Low","value":"low"}],"default":[],"description":"Urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this"},{"displayName":"User IDs","name":"userIds","type":"string","default":"","description":"Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs (multiple IDs can be added separated by comma)."}]},{"displayName":"Incident ID","name":"incidentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["incident"],"operation":["update"]}},"description":"Unique identifier for the incident"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"default":"","displayOptions":{"show":{"resource":["incident"],"operation":["update"]}},"description":"The email address of a valid user associated with the account making the request"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["incident"],"operation":["update"]}},"default":{},"options":[{"displayName":"Escalation Level","name":"escalationLevel","type":"number","default":0,"typeOptions":{"minValue":0},"description":"Escalate the incident to this level in the escalation policy"},{"displayName":"Escalation Policy Name or ID","name":"escalationPolicyId","type":"options","typeOptions":{"loadOptionsMethod":"getEscalationPolicies"},"default":"","description":"Delegate this incident to the specified escalation policy. Cannot be specified if an assignee is given. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Priority Name or ID","name":"priorityId","type":"options","typeOptions":{"loadOptionsMethod":"getPriorities"},"default":"","description":"The incident will be created on this service. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Resolution","name":"resolution","type":"string","default":"","description":"The resolution for this incident if status is set to resolved"},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Acknowledged","value":"acknowledged"},{"name":"Resolved","value":"resolved"}],"default":"","description":"The new status of the incident"},{"displayName":"Title","name":"title","type":"string","default":"","description":"A succinct description of the nature, symptoms, cause, or effect of the incident"},{"displayName":"Urgency","name":"urgency","type":"options","options":[{"name":"High","value":"high"},{"name":"Low","value":"low"}],"default":"","description":"The urgency of the incident"}]},{"displayName":"Conference Bridge","name":"conferenceBridgeUi","type":"fixedCollection","typeOptions":{"multipleValues":false},"placeholder":"Add Conference Bridge","displayOptions":{"show":{"resource":["incident"],"operation":["update"]}},"default":{},"options":[{"displayName":"Conference Bridge","name":"conferenceBridgeValues","values":[{"displayName":"Conference Number","name":"conferenceNumber","type":"string","default":"","description":"Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input"},{"displayName":"Conference URL","name":"conferenceUrl","type":"string","default":"","description":"An URL for the conference bridge. This could be a link to a web conference or Slack channel."}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["incidentNote"]}},"options":[{"name":"Create","value":"create","description":"Create a incident note","action":"Create an incident note"},{"name":"Get Many","value":"getAll","description":"Get many incident's notes","action":"Get many incident notes"}],"default":"create"},{"displayName":"Incident ID","name":"incidentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["incidentNote"],"operation":["create"]}},"description":"Unique identifier for the incident"},{"displayName":"Content","name":"content","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["incidentNote"],"operation":["create"]}},"description":"The note content"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"default":"","displayOptions":{"show":{"resource":["incidentNote"],"operation":["create"]}},"description":"The email address of a valid user associated with the account making the request"},{"displayName":"Incident ID","name":"incidentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["incidentNote"],"operation":["getAll"]}},"description":"Unique identifier for the incident"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["incidentNote"]}},"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":["incidentNote"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["logEntry"]}},"options":[{"name":"Get","value":"get","description":"Get a log entry","action":"Get a log entry"},{"name":"Get Many","value":"getAll","description":"Get many log entries","action":"Get many log entries"}],"default":"get"},{"displayName":"Log Entry ID","name":"logEntryId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["logEntry"],"operation":["get"]}},"description":"Unique identifier for the log entry"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["logEntry"]}},"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":["logEntry"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["logEntry"],"operation":["getAll"]}},"options":[{"displayName":"Include","name":"include","type":"multiOptions","options":[{"name":"Channels","value":"channels"},{"name":"Incidents","value":"incidents"},{"name":"Services","value":"services"},{"name":"Teams","value":"teams"}],"default":[],"description":"Additional details to include"},{"displayName":"Is Overview","name":"isOverview","type":"boolean","default":false,"description":"Whether to return a subset of log entries that show only the most important changes to the incident"},{"displayName":"Since","name":"since","type":"dateTime","default":"","description":"The start of the date range over which you want to search. (the limit on date ranges is 6 months)."},{"displayName":"Timezone Name or ID","name":"timeZone","type":"options","typeOptions":{"loadOptionsMethod":"getTimezones"},"default":"","description":"Time zone in which dates in the result will be rendered. If not set dates will return UTC. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Until","name":"until","type":"dateTime","default":"","description":"The end of the date range over which you want to search. (the limit on date ranges is 6 months)."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Get","value":"get","description":"Get a user","action":"Get a user"}],"default":"get"},{"displayName":"User ID","name":"userId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"description":"Unique identifier for the user"}]

operations:
  [{"type":"resource","resource":"incident","name":"Incident"},{"type":"resource","resource":"incidentNote","name":"Incident Note"},{"type":"resource","resource":"logEntry","name":"Log Entry"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"create","name":"Create","action":"Create an incident","resources":["incident"]},{"type":"operation","operation":"get","name":"Get","action":"Get an incident","resources":["incident"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many incidents","resources":["incident"]},{"type":"operation","operation":"update","name":"Update","action":"Update an incident","resources":["incident"]},{"type":"operation","operation":"create","name":"Create","action":"Create an incident note","resources":["incidentNote"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many incident notes","resources":["incidentNote"]},{"type":"operation","operation":"get","name":"Get","action":"Get a log entry","resources":["logEntry"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many log entries","resources":["logEntry"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]}]

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


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

  # PayPal node

  Use the PayPal node to automate work in PayPal, and integrate PayPal with other applications. n8n has built-in support for a wide range of PayPal features, including creating a batch payout and canceling unclaimed payout items. 

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

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

  ## Operations

  * Payout
      * Create a batch payout
      * Show batch payout details
  * Payout Item
      * Cancels an unclaimed payout item
      * Show payout item details

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Payout","value":"payout"},{"name":"Payout Item","value":"payoutItem"}],"default":"payout"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["payout"]}},"options":[{"name":"Create","value":"create","description":"Create a batch payout","action":"Create a payout"},{"name":"Get","value":"get","description":"Show batch payout details","action":"Get a payout"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["payoutItem"]}},"options":[{"name":"Cancel","value":"cancel","description":"Cancels an unclaimed payout item","action":"Cancel a payout item"},{"name":"Get","value":"get","description":"Show payout item details","action":"Get a payout item"}],"default":"get"},{"displayName":"Sender Batch ID","name":"senderBatchId","type":"string","required":true,"displayOptions":{"show":{"resource":["payout"],"operation":["create"]}},"default":"","description":"A sender-specified ID number. Tracks the payout in an accounting system."},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["payout"],"operation":["create"]}}},{"displayName":"Items","name":"itemsUi","placeholder":"Add Item","type":"fixedCollection","displayOptions":{"show":{"resource":["payout"],"operation":["create"],"jsonParameters":[false]}},"typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"itemsValues","displayName":"Item","values":[{"displayName":"Recipient Type","name":"recipientType","type":"options","options":[{"name":"Phone","value":"phone","description":"The unencrypted phone number"},{"name":"Email","value":"email","description":"The unencrypted email"},{"name":"PayPal ID","value":"paypalId","description":"The encrypted PayPal account number"}],"default":"email","description":"The ID type that identifies the recipient of the payment"},{"displayName":"Receiver Value","name":"receiverValue","type":"string","required":true,"default":"","description":"The receiver of the payment. Corresponds to the recipient_type value in the request. Max length: 127 characters."},{"displayName":"Currency","name":"currency","type":"options","options":[{"name":"Australian Dollar","value":"AUD"},{"name":"Brazilian Real","value":"BRL"},{"name":"Canadian Dollar","value":"CAD"},{"name":"Czech Koruna","value":"CZK"},{"name":"Danish Krone","value":"DKK"},{"name":"Euro","value":"EUR"},{"name":"United States Dollar","value":"USD"}],"default":"USD"},{"displayName":"Amount","name":"amount","type":"string","required":true,"default":"","description":"The value, which might be"},{"displayName":"Note","name":"note","type":"string","default":"","description":"The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters."},{"displayName":"Sender Item ID","name":"senderItemId","type":"string","default":"","description":"The sender-specified ID number. Tracks the payout in an accounting system."},{"displayName":"Recipient Wallet","name":"recipientWallet","type":"options","options":[{"name":"PayPal","value":"paypal","description":"PayPal Wallet"},{"name":"Venmo","value":"venmo","description":"Venmo Wallet"}],"default":"paypal"}]}]},{"displayName":"Items","name":"itemsJson","type":"json","default":"","typeOptions":{"alwaysOpenEditWindow":true},"description":"An array of individual payout items","displayOptions":{"show":{"resource":["payout"],"operation":["create"],"jsonParameters":[true]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["payout"],"operation":["create"]}},"options":[{"displayName":"Email Subject","name":"emailSubject","type":"string","default":"","description":"The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients. Max length: 255 characters."},{"displayName":"Email Message","name":"emailMessage","type":"string","default":"","description":"The email message that PayPal sends when the payout item completes. The message is the same for all recipients."},{"displayName":"Note","name":"note","type":"string","default":"","description":"The payouts and item-level notes are concatenated in the email. Max length: 1000 characters."}]},{"displayName":"Payout Batch ID","name":"payoutBatchId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["payout"],"operation":["get"]}},"description":"The ID of the payout for which to show details"},{"displayName":"Return All","name":"returnAll","type":"boolean","default":false,"displayOptions":{"show":{"resource":["payout"],"operation":["get"]}},"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","typeOptions":{"maxValue":1000,"minValue":1},"default":100,"displayOptions":{"show":{"resource":["payout"],"operation":["get"],"returnAll":[false]}},"description":"Max number of results to return"},{"displayName":"Payout Item ID","name":"payoutItemId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["payoutItem"],"operation":["get"]}},"description":"The ID of the payout item for which to show details"},{"displayName":"Payout Item ID","name":"payoutItemId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["payoutItem"],"operation":["cancel"]}},"description":"The ID of the payout item to cancel"}]

operations:
  [{"type":"resource","resource":"payout","name":"Payout"},{"type":"resource","resource":"payoutItem","name":"Payout Item"},{"type":"operation","operation":"create","name":"Create","action":"Create a payout","resources":["payout"]},{"type":"operation","operation":"get","name":"Get","action":"Get a payout","resources":["payout"]},{"type":"operation","operation":"cancel","name":"Cancel","action":"Cancel a payout item","resources":["payoutItem"]},{"type":"operation","operation":"get","name":"Get","action":"Get a payout item","resources":["payoutItem"]}]


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

  # PayPal Trigger node

  [PayPal](https://paypal.com){:target=_blank .external-link} is a digital payment service that supports online fund transfers that customers can use when shopping online.

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

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

properties_schema:
  [{"displayName":"Event Names or IDs","name":"events","type":"multiOptions","required":true,"default":[],"description":"The event to listen to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","typeOptions":{"loadOptionsMethod":"getEvents"},"options":[]}]


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

  # Peekalink node

  Use the Peekalink node to automate work in Peekalink, and integrate Peekalink with other applications. n8n supports checking, and reviewing links with Peekalink.

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

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

  ## Operations

  * Check whether preview for a given link is available
  * Return the preview for a link

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Is Available","value":"isAvailable","description":"Check whether preview for a given link is available","action":"Check whether the preview for a given link is available"},{"name":"Preview","value":"preview","description":"Return the preview for a link","action":"Return the preview for a link"}],"default":"preview"},{"displayName":"URL","name":"url","type":"string","default":"","required":true}]


