# nodes

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

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

  # Slack Trigger node

  Use the Slack Trigger node to respond to events in [Slack](https://slack.com/){:target=_blank .external-link} and integrate Slack with other applications. n8n has built-in support for a wide range of Slack events, including new messages, reactions, and new channels.

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

  ///  note  | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/slack.md).
  ///
  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [Slack integrations](https://n8n.io/integrations/slack-trigger/){:target=_blank .external-link} page.
  ///

  ## Events

  * **Any Event**: The node triggers on any event in Slack.
  * **Bot / App Mention**: The node triggers when your bot or app is [mentioned](https://slack.com/help/articles/205240127-Use-mentions-in-Slack){:target=_blank .external-link} in a channel the app is in.
  * **File Made Public**: The node triggers when a file is [made public](https://slack.com/help/articles/4412651915539-Manage-public-file-sharing){:target=_blank .external-link}.
  * **File Shared**: The node triggers when a file is [shared](https://slack.com/help/articles/201330736-Add-files-to-Slack){:target=_blank .external-link} in a channel the app is in.
  * **New Message Posted to Channel**: The node triggers when a new message is posted to a channel the app is in.
  * **New Public Channel Created**: The node triggers when a new [public channel](https://slack.com/help/articles/360017938993-What-is-a-channel){:target=_blank .external-link} is created.
  * **New User**: The node triggers when a new user is added to Slack.
  * **Reaction Added**: The node triggers when a [reaction](https://slack.com/help/articles/202931348-Use-emoji-and-reactions){:target=_blank .external-link} is added to a message the app is added to.

  ## Parameters

  Once you've set the events to trigger on, use the remaining parameters to further define the node's behavior:

  * **Watch Whole Workspace**: Whether the node should watch for the selected **Events** in all channels in the workspace (turned on) or not (turned off, default).

      ///warning | Caution
      This will use one execution for every event in any channel your bot or app is in. Use with caution!
      ///

  * **Channel to Watch**: Select the channel your node should watch for the selected **Events**. This parameter only appears if you don't turn on **Watch Whole Workspace**. You can select a channel:
      * **From list**: The node uses your credential to look up a list of channels in the workspace so you can select the channel you want.
      * **By ID**: Enter the ID of a channel you want to watch. Slack displays the channel ID at the bottom of the channel details with a one-click copy button.
      * **By URL**: Enter the URL of the channel you want to watch, formatted as `https://app.slack.com/client/<channel-address>`.
  * **Download Files**: Whether to download files and use them in the node's output (turned on) or not (turned off, default). Use this parameter with the **File Made Public** and **File Shared** events.

  ## Options

  You can further refine the node's behavior when you **Add Option**s:

  * **Resolve IDs**: Whether to resolve the IDs to their respective names and return them (turned on) or not (turned off, default).
  * **Usernames or IDs to ignore**: Select usernames or enter a comma-separated string of encoded user IDs to ignore events from. Choose from the list, or specify IDs using an [expression](/code/expressions.md).

  ## Related resources

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

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

  Refer to [Slack's documentation](https://api.slack.com/apis/connections/events-api){:target=_blank .external-link} for details about their API.

  ## Required scopes

  To use this node, you need to create an application in Slack and enable event subscriptions. Refer to [Slack credentials | Slack Trigger configuration](/integrations/builtin/credentials/slack.md#slack-trigger-configuration) for more information.

  You must add the appropriate scopes to your Slack app for this trigger node to work.

  The node requires scopes for the [conversations.list](https://api.slack.com/methods/conversations.list){:target=blank .external-link} and [users.list](https://api.slack.com/methods/users.list){:target=blank .external-link} methods at minimum. Check out the [Scopes | Slack credentials](/integrations/builtin/credentials/slack.md#scopes) list for a more complete list of scopes.

  ## Common issues

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

  ### Workflow only works in testing or production

  Slack only allows you to register a single webhook per app. This means that you can't switch from using the testing URL to the production URL (and vice versa) without reconfiguring the registered webhook URL. 

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

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

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

  1. Go to your workflow page.
  2. Toggle the **Active** switch in the top panel to disable the workflow temporarily.
  3. Edit the **Request URL** in your the [Slack Trigger configuration](/integrations/builtin/credentials/slack.md#slack-trigger-configuration) to use the testing webhook URL instead of the production webhook URL.
  4. Test your workflow using the test webhook URL.
  5. When you finish testing, edit the **Request URL** in your the [Slack Trigger configuration](/integrations/builtin/credentials/slack.md#slack-trigger-configuration) to use the production webhook URL instead of the testing webhook URL.
  6. Toggle the **Inactive** toggle to enable the workflow again. The production webhook URL should resume working.

  ### Token expired

  --8<-- "_snippets/integrations/builtin/credentials/slack/token-rotation.md"

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "hidden",
      "default": "accessToken"
    },
    {
      "displayName": "Set up a webhook in your Slack app to enable this node. <a href=\"https://docs.n8n.io/integrations/builtin/trigger-nodes/n8n-nodes-base.slacktrigger/#configure-a-webhook-in-slack\" target=\"_blank\">More info</a>",
      "name": "notice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Trigger On",
      "name": "trigger",
      "type": "multiOptions",
      "default": [],
      "options": [
        {
          "name": "Any Event",
          "value": "any_event",
          "description": "Triggers on any event"
        },
        {
          "name": "Bot / App Mention",
          "value": "app_mention",
          "description": "When your bot or app is mentioned in a channel the app is added to"
        },
        {
          "name": "File Made Public",
          "value": "file_public",
          "description": "When a file is made public"
        },
        {
          "name": "File Shared",
          "value": "file_share",
          "description": "When a file is shared in a channel the app is added to"
        },
        {
          "name": "New Message Posted to Channel",
          "value": "message",
          "description": "When a message is posted to a channel the app is added to"
        },
        {
          "name": "New Public Channel Created",
          "value": "channel_created",
          "description": "When a new public channel is created"
        },
        {
          "name": "New User",
          "value": "team_join",
          "description": "When a new user is added to Slack"
        },
        {
          "name": "Reaction Added",
          "value": "reaction_added",
          "description": "When a reaction is added to a message the app is added to"
        }
      ]
    },
    {
      "displayName": "Watch Whole Workspace",
      "name": "watchWorkspace",
      "type": "boolean",
      "default": false,
      "description": "Whether to watch for the event in the whole workspace, rather than a specific channel",
      "displayOptions": {
        "show": {
          "trigger": [
            "any_event",
            "message",
            "reaction_added",
            "file_share",
            "app_mention"
          ]
        }
      }
    },
    {
      "displayName": "This will use one execution for every event in any channel your bot is in, use with caution",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "trigger": [
            "any_event",
            "message",
            "reaction_added",
            "file_share",
            "app_mention"
          ],
          "watchWorkspace": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Channel to Watch",
      "name": "channelId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The Slack channel to listen to events from. Applies to events: Bot/App mention, File Shared, New Message Posted on Channel, Reaction Added.",
      "required": true,
      "displayOptions": {
        "show": {
          "watchWorkspace": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Download Files",
      "name": "downloadFiles",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the files and add it to the output",
      "displayOptions": {
        "show": {
          "trigger": [
            "any_event",
            "file_share"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Resolve IDs",
          "name": "resolveIds",
          "type": "boolean",
          "default": false,
          "description": "Whether to resolve the IDs to their respective names and return them"
        },
        {
          "displayName": "Usernames or IDs to Ignore",
          "name": "userIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "default": [],
          "description": "A comma-separated string of encoded user IDs. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ]
    }
  ]


node_type: nodes-base.sms77
package_name: n8n-nodes-base
display_name: seven
description: Send SMS and make text-to-speech calls
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "send",
  "name": "Send",
  "description": "Send SMS"
  }
  ]

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

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: seven node documentation
  description: Learn how to use the seven node in n8n. Follow technical documentation to integrate seven node into your workflows.
  contentType: [integration, reference]
  ---

  # seven node

  Use the seven node to automate work in seven, and integrate seven with other applications. n8n has built-in support for a wide range of seven features, including sending SMS, and converting text to voice. 

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

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

  ## Operations

  * SMS
      * Send SMS
  * Voice Call
      * Converts text to voice and calls a given number

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "sms",
      "options": [
        {
          "name": "SMS",
          "value": "sms"
        },
        {
          "name": "Voice Call",
          "value": "voice"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send SMS",
          "action": "Send an SMS"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Converts text to voice and calls a given number",
          "action": "Convert text to voice"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "voice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From",
      "name": "from",
      "type": "string",
      "default": "",
      "description": "The caller ID displayed in the receivers display. Max 16 numeric or 11 alphanumeric characters.",
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms"
          ]
        }
      }
    },
    {
      "displayName": "To",
      "name": "to",
      "type": "string",
      "default": "",
      "description": "The number of your recipient(s) separated by comma. Can be regular numbers or contact/groups from seven.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms",
            "voice"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The message to send. Max. 1520 characters",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms",
            "voice"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delay",
          "name": "delay",
          "type": "dateTime",
          "default": "",
          "description": "Pick a date for time delayed dispatch"
        },
        {
          "displayName": "Foreign ID",
          "name": "foreign_id",
          "type": "string",
          "default": "",
          "placeholder": "MyCustomForeignID",
          "description": "Custom foreign ID returned in DLR callbacks"
        },
        {
          "displayName": "Flash",
          "name": "flash",
          "type": "boolean",
          "default": false,
          "description": "Send as flash message being displayed directly the receiver's display"
        },
        {
          "displayName": "Label",
          "name": "label",
          "type": "string",
          "default": "",
          "placeholder": "MyCustomLabel",
          "description": "Custom label used to group analytics"
        },
        {
          "displayName": "Performance Tracking",
          "name": "performance_tracking",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable performance tracking for URLs found in the message text"
        },
        {
          "displayName": "TTL",
          "name": "ttl",
          "type": "number",
          "default": 2880,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Custom time to live specifying the validity period of a message in minutes"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "sms"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "From",
          "name": "from",
          "type": "string",
          "default": "",
          "placeholder": "+4901234567890",
          "description": "The caller ID. Please use only verified sender IDs, one of your virtual inbound numbers or one of our shared virtual numbers."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "send"
          ],
          "resource": [
            "voice"
          ]
        }
      }
    }
  ]


node_type: nodes-base.snowflake
package_name: n8n-nodes-base
display_name: Snowflake
description: Get, add and update data in Snowflake
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "snowflake",
  "required": true
  }
  ]

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Snowflake node documentation
  description: Learn how to use the Snowflake node in n8n. Follow technical documentation to integrate Snowflake node into your workflows.
  contentType: [integration, reference]
  ---

  # Snowflake node

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

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

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

  ## Operations

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

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "insert",
      "options": [
        {
          "name": "Execute Query",
          "value": "executeQuery",
          "description": "Execute an SQL query",
          "action": "Execute a SQL query"
        },
        {
          "name": "Insert",
          "value": "insert",
          "description": "Insert rows in database",
          "action": "Insert rows in database"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update rows in database",
          "action": "Update rows in database"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The SQL query to execute",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "executeQuery"
          ]
        }
      },
      "typeOptions": {
        "editor": "sqlEditor"
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table",
      "name": "table",
      "type": "string",
      "default": "",
      "description": "Name of the table in which to insert data to",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "insert"
          ]
        }
      }
    },
    {
      "displayName": "Columns",
      "name": "columns",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the properties which should used as columns for the new rows",
      "displayOptions": {
        "show": {
          "operation": [
            "insert"
          ]
        }
      }
    },
    {
      "displayName": "Table",
      "name": "table",
      "type": "string",
      "default": "",
      "description": "Name of the table in which to update data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Key",
      "name": "updateKey",
      "type": "string",
      "default": "id",
      "description": "Name of the property which decides which rows in the database should be updated. Normally that would be \"id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Columns",
      "name": "columns",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the properties which should used as columns for rows to update",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "executeQuery",
      "name": "Execute Query",
      "description": "Execute an SQL query"
    },
    {
      "operation": "insert",
      "name": "Insert",
      "description": "Insert rows in database"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update rows in database"
    }
  ]


node_type: nodes-base.splitInBatches
package_name: n8n-nodes-base
display_name: Split In Batches
description: Split data into batches and iterate over each batch
category: organization
development_style: programmatic
version: 3
operations: []
credentials_required: []
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Loop Over Items (Split in Batches)
  description: Documentation for the Loop Over Items node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  ---

  # Loop Over Items

  The Loop Over Items node helps you loop through data when needed.

  The node saves the original incoming data, and with each iteration, returns a predefined amount of data through the **loop** output.

  When the node execution completes, it combines all of the processed data and returns it through the **done** output.

  ## When to use the Loop Over Items node

  By default, n8n nodes are designed to process a list of input items (with some exceptions, detailed below). Depending on what you're trying to achieve, you often don't need the Loop Over Items node in your workflow. You can learn more about how n8n processes multiple items on the [looping in n8n](/flow-logic/looping.md) page.

  These links highlight some of the cases where the Loop Over Items node can be useful:

  * [Loop until all items are processed](/flow-logic/looping.md#loop-until-all-items-are-processed): describes how the Loop Over Items node differs from normal item processing and when you might want to incorporate this node.
  * [Node exceptions](/flow-logic/looping.md#node-exceptions): outlines specific cases and nodes where you may need to use the Loop Over Items node to manually build looping logic.
  * [Avoiding rate limiting](/integrations/builtin/rate-limits.md): demonstrates how to batch API requests to avoid rate limits from other services.

  ## Node parameters

  ### Batch Size

  Enter the number of items to return with each call.

  ## Node options

  ### Reset

  If turned on, the node will reset with the current input-data newly initialized with each loop. Use this when you want the Loop Over Items node to treat incoming data as a new set of data instead of a continuation of previous items.

  For example, you can use the Loop Over Items node with the reset option and an [If node](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) to query a paginated service when you don't know how many pages you need in advance. The loop queries pages one at a time, performs any processing, and increments the page number. The loop reset ensures the loop recognizes each iteration as a new set of data. The If node evaluates an exit condition to decide whether to perform another iteration or not.

  /// warning | Include a valid termination condition
  For workflows like the example described above, it's critical to include a valid termination condition for the loop. If your termination condition never matches, your workflow execution will get stuck in an infinite loop.
  ///

  When enabled, you can adjust the reset conditions by switching the parameter representation from **Fixed** to **Expression**. The results of your expression evaluation determine when the node will reset item processing.

  ## Templates and examples

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

  ### Read RSS feed from two different sources

  This workflow allows you to read an RSS feed from two different sources using the Loop Over Items node. You need the Loop Over Items node in the workflow as the RSS Feed Read node only processes the first item it receives. You can also find the [workflow](https://n8n.io/workflows/687-read-rss-feed-from-two-different-sources/){:target=_blank .external-link} on n8n.io.

  The example walks through building the workflow, but assumes you are already familiar with n8n. To build your first workflow, including learning how to add nodes to a workflow, refer to [Try it out](/try-it-out/index.md).

  The final workflow looks like this:

  [[ workflowDemo("file:///integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/rss-feed-example.json") ]]

  Copy the workflow file above and paste into your instance, or manually build it by following these steps:

  1. Add the manual trigger.
  2. Add the Code node.
  3. Copy this code into the Code node:
  	```js
  	return [
  		{
  			json: {
  				url: 'https://medium.com/feed/n8n-io',
  			}
  		},
  		{
  			json: {
  				url: 'https://dev.to/feed/n8n',
  			}
  		}
  	];
  	```
  4. Add the Loop Over Items node.
  5. Configure Loop Over Items: set the batch size to `1` in the **Batch Size** field.
  6. Add the RSS Feed Read node.
  7. Select **Test Workflow**. This runs the workflow to load data into the RSS Feed Read node.
  8. Configure RSS Feed Read: map `url` from the input to the **URL** field. You can do this by dragging and dropping from the **INPUT** panel, or using this expression: `{{ $json.url }}`.
  9. Select **Test Workflow** to run the workflow and see the resulting data.

  ### Check that the node has processed all items

  To check if the node still has items to process, use the following expression: `{{$node["Loop Over Items"].context["noItemsLeft"]}}`. This expression returns a boolean value. If the node still has data to process, the expression returns `false`, otherwise it returns `true`.

  ### Get the current running index of the node

  To get the current running index of the node, use the following expression: `{{$node["Loop Over Items"].context["currentRunIndex"];}}`.

properties_schema:
  [
    {
      "displayName": "You may not need this node — n8n nodes automatically run once for each input item. <a href=\"https://docs.n8n.io/getting-started/key-concepts/looping.html#using-loops-in-n8n\" target=\"_blank\">More info</a>",
      "name": "splitInBatchesNotice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Batch Size",
      "name": "batchSize",
      "type": "number",
      "default": 1,
      "description": "The number of items to return with each call",
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Reset",
          "name": "reset",
          "type": "boolean",
          "default": false,
          "description": "Whether the node starts again from the beginning of the input items. This will treat incoming data as a new set rather than continuing with the previous items."
        }
      ]
    }
  ]


node_type: nodes-base.splunk
package_name: n8n-nodes-base
display_name: Splunk
description: Consume the Splunk Enterprise API
category: transform
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "splunkApi",
  "required": true
  }
  ]

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Splunk node documentation
  description: Learn how to use the Splunk node in n8n. Follow technical documentation to integrate Splunk node into your workflows.
  contentType: [integration, reference]
  ---

  # Splunk node

  Use the Splunk node to automate work in Splunk, and integrate Splunk with other applications. n8n has built-in support for a wide range of Splunk features, including getting fired alerts reports, as well as deleting and getting search configuration. 

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

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

  ## Operations

  * Fired Alert
      * Get a fired alerts report
  * Search Configuration
      * Delete a search configuration
      * Get a search configuration
      * Get many search configurations
  * Search Job
      * Create a search job
      * Delete a search job
      * Get a search job
      * Get many search jobs
  * Search Result
      * Get many search results
  * User
      * Create a user
      * Delete a user
      * Get a user
      * Get many users
      * Update a user

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "search",
      "options": [
        {
          "name": "Alert",
          "value": "alert"
        },
        {
          "name": "Report",
          "value": "report"
        },
        {
          "name": "Search",
          "value": "search"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getReport",
      "options": [
        {
          "name": "Get Fired Alerts",
          "value": "getReport",
          "description": "Retrieve a fired alerts report",
          "action": "Get a fired alerts report"
        },
        {
          "name": "Get Metrics",
          "value": "getMetrics",
          "description": "Retrieve metrics",
          "action": "Get metrics"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "alert"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create From Search",
          "value": "create",
          "description": "Create a search report from a search job",
          "action": "Create a search report"
        },
        {
          "name": "Delete",
          "value": "deleteReport",
          "description": "Delete a search report",
          "action": "Delete a search report"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a search report",
          "action": "Get a search report"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many search reports",
          "action": "Get many search reports"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Search Job",
      "name": "searchJobId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the report",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Report",
      "name": "reportId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "deleteReport"
          ]
        }
      }
    },
    {
      "displayName": "Report",
      "name": "reportId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "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": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Add Orphan Field",
          "name": "add_orphan_field",
          "description": "Whether to include a boolean value for each saved search to show whether the search is orphaned, meaning that it has no valid owner",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "List Default Actions",
          "name": "listDefaultActionArgs",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a search job",
          "action": "Create a search job"
        },
        {
          "name": "Delete",
          "value": "deleteJob",
          "description": "Delete a search job",
          "action": "Delete a search job"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a search job",
          "action": "Get a search job"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many search jobs",
          "action": "Get many search jobs"
        },
        {
          "name": "Get Result",
          "value": "getResult",
          "description": "Get the result of a search job",
          "action": "Get the result of a search job"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Query",
      "name": "search",
      "type": "string",
      "default": "",
      "description": "Search language string to execute, in Splunk's <a href=\"https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/WhatsInThisManual\">Search Processing Language</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "rows": 2
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Ad Hoc Search Level",
          "name": "adhoc_search_level",
          "type": "options",
          "default": "verbose",
          "options": [
            {
              "name": "Fast",
              "value": "fast"
            },
            {
              "name": "Smart",
              "value": "smart"
            },
            {
              "name": "Verbose",
              "value": "verbose"
            }
          ]
        },
        {
          "displayName": "Auto-Cancel After (Seconds)",
          "name": "auto_cancel",
          "type": "number",
          "default": 0,
          "description": "Seconds after which the search job automatically cancels"
        },
        {
          "displayName": "Auto-Finalize After (Num Events)",
          "name": "auto_finalize_ec",
          "type": "number",
          "default": 0,
          "description": "Auto-finalize the search after at least this many events are processed"
        },
        {
          "displayName": "Auto Pause After (Seconds)",
          "name": "auto_pause",
          "type": "number",
          "default": 0,
          "description": "Seconds of inactivity after which the search job automatically pauses"
        },
        {
          "displayName": "Earliest Index",
          "name": "index_earliest",
          "type": "dateTime",
          "default": "",
          "description": "The earliest index time for the search (inclusive)"
        },
        {
          "displayName": "Earliest Time",
          "name": "earliest_time",
          "type": "dateTime",
          "default": "",
          "description": "The earliest cut-off for the search (inclusive)"
        },
        {
          "displayName": "Exec Mode",
          "name": "exec_mode",
          "type": "options",
          "default": "blocking",
          "options": [
            {
              "name": "Blocking",
              "value": "blocking"
            },
            {
              "name": "Normal",
              "value": "normal"
            },
            {
              "name": "One Shot",
              "value": "oneshot"
            }
          ]
        },
        {
          "displayName": "Indexed Real Time Offset",
          "name": "indexedRealtimeOffset",
          "type": "number",
          "default": 0,
          "description": "Seconds of disk sync delay for indexed real-time search"
        },
        {
          "displayName": "Latest Index",
          "name": "index_latest",
          "type": "dateTime",
          "default": "",
          "description": "The latest index time for the search (inclusive)"
        },
        {
          "displayName": "Latest Time",
          "name": "latest_time",
          "type": "dateTime",
          "default": "",
          "description": "The latest cut-off for the search (inclusive)"
        },
        {
          "displayName": "Max Time",
          "name": "max_time",
          "type": "number",
          "default": 0,
          "description": "Number of seconds to run this search before finalizing. Enter <code>0</code> to never finalize."
        },
        {
          "displayName": "Namespace",
          "name": "namespace",
          "type": "string",
          "default": "",
          "description": "Application namespace in which to restrict searches"
        },
        {
          "displayName": "Reduce Frequency",
          "name": "reduce_freq",
          "type": "number",
          "default": 0,
          "description": "How frequently to run the MapReduce reduce phase on accumulated map values"
        },
        {
          "displayName": "Remote Server List",
          "name": "remote_server_list",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of (possibly wildcarded) servers from which raw events should be pulled. This same server list is to be used in subsearches."
        },
        {
          "displayName": "Reuse Limit (Seconds)",
          "name": "reuse_max_seconds_ago",
          "type": "number",
          "default": 0,
          "description": "Number of seconds ago to check when an identical search is started and return the job’s search ID instead of starting a new job"
        },
        {
          "displayName": "Required Field",
          "name": "rf",
          "type": "string",
          "default": "",
          "description": "Name of a required field to add to the search. Even if not referenced or used directly by the search, a required field is still included in events and summary endpoints."
        },
        {
          "displayName": "Search Mode",
          "name": "search_mode",
          "type": "options",
          "default": "normal",
          "options": [
            {
              "name": "Normal",
              "value": "normal"
            },
            {
              "name": "Real Time",
              "value": "realtime"
            }
          ]
        },
        {
          "displayName": "Status Buckets",
          "name": "status_buckets",
          "type": "number",
          "default": 0,
          "description": "The most status buckets to generate. Set <code>0</code> generate no timeline information."
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "type": "number",
          "default": 86400,
          "description": "Number of seconds to keep this search after processing has stopped"
        },
        {
          "displayName": "Workload Pool",
          "name": "workload_pool",
          "type": "string",
          "default": "",
          "description": "New workload pool where the existing running search should be placed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Search Job",
      "name": "searchJobId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "deleteJob"
          ]
        }
      }
    },
    {
      "displayName": "Search Job",
      "name": "searchJobId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "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": [
            "search"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "search"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Sort",
      "name": "sort",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Sort Direction",
              "name": "sort_dir",
              "type": "options",
              "options": [
                {
                  "name": "Ascending",
                  "value": "asc"
                },
                {
                  "name": "Descending",
                  "value": "desc"
                }
              ],
              "default": "asc"
            },
            {
              "displayName": "Sort Key",
              "name": "sort_key",
              "description": "Key name to use for sorting",
              "type": "string",
              "placeholder": "e.g. diskUsage",
              "default": ""
            },
            {
              "displayName": "Sort Mode",
              "name": "sort_mode",
              "type": "options",
              "options": [
                {
                  "name": "Automatic",
                  "value": "auto",
                  "description": "If all field values are numeric, collate numerically. Otherwise, collate alphabetically."
                },
                {
                  "name": "Alphabetic",
                  "value": "alpha",
                  "description": "Collate alphabetically, case-insensitive"
                },
                {
                  "name": "Alphabetic and Case-Sensitive",
                  "value": "alpha_case",
                  "description": "Collate alphabetically, case-sensitive"
                },
                {
                  "name": "Numeric",
                  "value": "num",
                  "description": "Collate numerically"
                }
              ],
              "default": "auto"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Search Job",
      "name": "searchJobId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "getResult"
          ]
        }
      }
    },
    {
      "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": [
            "search"
          ],
          "operation": [
            "getResult"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "search"
          ],
          "operation": [
            "getResult"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Key-Value Match",
          "name": "keyValueMatch",
          "description": "Key-value pair to match against. Example: if \"Key\" is set to <code>user</code> and \"Field\" is set to <code>john</code>, only the results where <code>user</code> is <code>john</code> will be returned.",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Key-Value Pair",
          "options": [
            {
              "displayName": "Key-Value Pair",
              "name": "keyValuePair",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "description": "Key to match against",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "description": "Value to match against",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "getResult"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Add Summary to Metadata",
          "name": "add_summary_to_metadata",
          "description": "Whether to include field summary statistics in the response",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "search"
          ],
          "operation": [
            "getResult"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an user",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "deleteUser",
          "description": "Delete an user",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve an user",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many users",
          "action": "Get many users"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an user",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Login name of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Roles",
      "name": "roles",
      "type": "multiOptions",
      "default": [
        "user"
      ],
      "description": "Comma-separated list of roles to assign to the user. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getRoles"
      }
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Full Name",
          "name": "realname",
          "type": "string",
          "default": "",
          "description": "Full name of the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "userId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "deleteUser"
          ]
        }
      }
    },
    {
      "displayName": "User",
      "name": "userId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "returnAll": [
            false
          ],
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "User",
      "name": "userId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Full Name",
          "name": "realname",
          "type": "string",
          "default": "",
          "description": "Full name of the user"
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": ""
        },
        {
          "displayName": "Role Names or IDs",
          "name": "roles",
          "type": "multiOptions",
          "description": "Comma-separated list of roles to assign to the user. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getRoles"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getReport",
      "name": "Get Fired Alerts",
      "description": "Retrieve a fired alerts report"
    },
    {
      "operation": "getMetrics",
      "name": "Get Metrics",
      "description": "Retrieve metrics"
    }
  ]


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

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Spontit node documentation
  description: Learn how to use the Spontit node in n8n. Follow technical documentation to integrate Spontit node into your workflows.
  contentType: [integration, reference]
  ---

  # Spontit node

  Use the Spontit node to automate work in Spontit, and integrate Spontit with other applications. n8n supports creating push notifications with Spontit. 

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

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

  ## Operations

  * Push
      * Create a push notification

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "push",
      "options": [
        {
          "name": "Push",
          "value": "push"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a push notification",
          "action": "Create a push notification"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "push"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "To provide text in a push, supply one of either \"content\" or \"pushContent\" (or both). Limited to 2500 characters. (Required if a value for \"pushContent\" is not provided).",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "push"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Channel Name",
          "name": "channelName",
          "type": "string",
          "default": "",
          "description": "The name of a channel you created. If you have not yet created a channel, simply don't provide this value and the push will be sent to your main account."
        },
        {
          "displayName": "Expiration Stamp",
          "name": "expirationStamp",
          "type": "dateTime",
          "default": "",
          "description": "A Unix timestamp. When to automatically expire your push notification. The default is 10 days after pushing. The push will become unaccessible within 15-30 minutes of the selected time, but will remain on all device screens until dismissed or clicked."
        },
        {
          "displayName": "iOS DeepLink",
          "name": "iOSDeepLink",
          "type": "string",
          "default": "",
          "description": "An iOS deep link. Use this to deep link into other apps. Alternatively, you can provide a universal link in the link attribute and set openLinkInApp to false."
        },
        {
          "displayName": "Link",
          "name": "link",
          "type": "string",
          "default": "",
          "description": "A link that can be attached to your push. Must be a valid URL."
        },
        {
          "displayName": "Open In Home Feed",
          "name": "openInHomeFeed",
          "type": "boolean",
          "default": false,
          "description": "Whether the notification opens to the home feed or to a standalone page with the notification. The default (openInHomeFeed=False) is to open the notification on a standalone page."
        },
        {
          "displayName": "Open Link In App",
          "name": "openLinkInApp",
          "type": "boolean",
          "default": false,
          "description": "Whether to open the provided link within the iOS app or in Safari. Android PWA opens all links in the default web browser."
        },
        {
          "displayName": "Push To Emails",
          "name": "pushToEmails",
          "type": "string",
          "default": "",
          "description": "<p>Emails (strings) to whom to send the notification. If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails' are not supplied, then everyone who follows the channel will receive the push notification.</p><p>If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.</p><p>If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.</p><p>See the \"Followers\" section to learn how to list the userIds of those who follow one of your channels.</p>."
        },
        {
          "displayName": "Push To Followers",
          "name": "pushToFollowers",
          "type": "string",
          "default": "",
          "description": "<p>User IDs (strings) to whom to send the notification. If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails' are not supplied, then everyone who follows the channel will receive the push notification.</p><p>If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.</p><p>If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.</p><p>See the \"Followers\" section to learn how to list the userIds of those who follow one of your channels.</p>."
        },
        {
          "displayName": "Push To Phone Numbers",
          "name": "pushToPhoneNumbers",
          "type": "string",
          "default": "",
          "description": "<p>Phone numbers (strings) to whom to send the notification. If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails' are not supplied, then everyone who follows the channel will receive the push notification.</p><p>If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.</p><p>If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.</p><p>See the \"Followers\" section to learn how to list the userIds of those who follow one of your channels.</p>."
        },
        {
          "displayName": "Schedule",
          "name": "schedule",
          "type": "dateTime",
          "default": "",
          "description": "A Unix timestamp. Schedule a push to be sent at a later date and time."
        },
        {
          "displayName": "Subtitle",
          "name": "subtitle",
          "type": "string",
          "default": "",
          "description": "The subtitle of your push. Limited to 20 characters. Only appears on iOS devices."
        },
        {
          "displayName": "Title",
          "name": "pushTitle",
          "type": "string",
          "default": "",
          "description": "The title of push. Appears in bold at the top. Limited to 100 characters."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "push"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a push notification"
    }
  ]


node_type: nodes-base.spotify
package_name: n8n-nodes-base
display_name: Spotify
description: Access public song data via the Spotify API
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "spotifyOAuth2Api",
  "required": true
  }
  ]

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

  # Spotify node

  Use the Spotify node to automate work in Spotify, and integrate Spotify with other applications. n8n has built-in support for a wide range of Spotify features, including getting album and artist information. 

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

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

  ## Operations

  * Album
      * Get an album by URI or ID.
      * Get a list of new album releases.
      * Get an album's tracks by URI or ID.
      * Search albums by keyword.
  * Artist
      * Get an artist by URI or ID.
      * Get an artist's albums by URI or ID.
      * Get an artist's related artists by URI or ID.
      * Get an artist's top tracks by URI or ID.
      * Search artists by keyword.
  * Library
      * Get the user's liked tracks.
  * My Data
      * Get your followed artists.
  * Player
      * Add a song to your queue.
      * Get your currently playing track.
      * Skip to your next track.
      * Pause your music.
      * Skip to your previous song.
      * Get your recently played tracks.
      * Resume playback on the current active device.
      * Set volume on the current active device.
      * Start playing a playlist, artist, or album.
  * Playlist
      * Add tracks from a playlist by track and playlist URI or ID.
      * Create a new playlist.
      * Get a playlist by URI or ID.
      * Get a playlist's tracks by URI or ID.
      * Get a user's playlists.
      * Remove tracks from a playlist by track and playlist URI or ID.
      * Search playlists by keyword.
  * Track
      * Get a track by its URI or ID.
      * Get audio features for a track by URI or ID.
      * Search tracks by keyword

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "player",
      "options": [
        {
          "name": "Album",
          "value": "album"
        },
        {
          "name": "Artist",
          "value": "artist"
        },
        {
          "name": "Library",
          "value": "library"
        },
        {
          "name": "My Data",
          "value": "myData"
        },
        {
          "name": "Player",
          "value": "player"
        },
        {
          "name": "Playlist",
          "value": "playlist"
        },
        {
          "name": "Track",
          "value": "track"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "addSongToQueue",
      "options": [
        {
          "name": "Add Song to Queue",
          "value": "addSongToQueue",
          "description": "Add a song to your queue",
          "action": "Add a song to a queue"
        },
        {
          "name": "Currently Playing",
          "value": "currentlyPlaying",
          "description": "Get your currently playing track",
          "action": "Get the currently playing track"
        },
        {
          "name": "Next Song",
          "value": "nextSong",
          "description": "Skip to your next track",
          "action": "Skip to the next track"
        },
        {
          "name": "Pause",
          "value": "pause",
          "description": "Pause your music",
          "action": "Pause the player"
        },
        {
          "name": "Previous Song",
          "value": "previousSong",
          "description": "Skip to your previous song",
          "action": "Skip to the previous song"
        },
        {
          "name": "Recently Played",
          "value": "recentlyPlayed",
          "description": "Get your recently played tracks",
          "action": "Get the recently played tracks"
        },
        {
          "name": "Resume",
          "value": "resume",
          "description": "Resume playback on the current active device",
          "action": "Resume the player"
        },
        {
          "name": "Set Volume",
          "value": "volume",
          "description": "Set volume on the current active device",
          "action": "Set volume on the player"
        },
        {
          "name": "Start Music",
          "value": "startMusic",
          "description": "Start playing a playlist, artist, or album",
          "action": "Start music on the player"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "player"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Resource ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Enter a playlist, artist, or album URI or ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "player"
          ],
          "operation": [
            "startMusic"
          ]
        }
      }
    },
    {
      "displayName": "Track ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Enter a track URI or ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "player"
          ],
          "operation": [
            "addSongToQueue"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get an album by URI or ID",
          "action": "Get an album"
        },
        {
          "name": "Get New Releases",
          "value": "getNewReleases",
          "description": "Get a list of new album releases",
          "action": "Get new album releases"
        },
        {
          "name": "Get Tracks",
          "value": "getTracks",
          "description": "Get an album's tracks by URI or ID",
          "action": "Get an album's tracks by URI or ID"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search albums by keyword",
          "action": "Search albums by keyword"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "album"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Album ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The album's Spotify URI or ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "album"
          ],
          "operation": [
            "get",
            "getTracks"
          ]
        },
        "hide": {
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Search Keyword",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The keyword term to search for",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "album"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get an artist by URI or ID",
          "action": "Get an artist"
        },
        {
          "name": "Get Albums",
          "value": "getAlbums",
          "description": "Get an artist's albums by URI or ID",
          "action": "Get an artist's albums by URI or ID"
        },
        {
          "name": "Get Related Artists",
          "value": "getRelatedArtists",
          "description": "Get an artist's related artists by URI or ID",
          "action": "Get an artist's related artists by URI or ID"
        },
        {
          "name": "Get Top Tracks",
          "value": "getTopTracks",
          "description": "Get an artist's top tracks by URI or ID",
          "action": "Get an artist's top tracks by URI or ID"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search artists by keyword",
          "action": "Search artists by keyword"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "artist"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Artist ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The artist's Spotify URI or ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "artist"
          ]
        },
        "hide": {
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Country",
      "name": "country",
      "type": "string",
      "default": "US",
      "description": "Top tracks in which country? Enter the postal abbreviation",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "artist"
          ],
          "operation": [
            "getTopTracks"
          ]
        }
      }
    },
    {
      "displayName": "Search Keyword",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The keyword term to search for",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "artist"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add an Item",
          "value": "add",
          "description": "Add tracks to a playlist by track and playlist URI or ID",
          "action": "Add an Item to a playlist"
        },
        {
          "name": "Create a Playlist",
          "value": "create",
          "description": "Create a new playlist",
          "action": "Create a playlist"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a playlist by URI or ID",
          "action": "Get a playlist"
        },
        {
          "name": "Get the User's Playlists",
          "value": "getUserPlaylists",
          "description": "Get a user's playlists",
          "action": "Get a user's playlists"
        },
        {
          "name": "Get Tracks",
          "value": "getTracks",
          "description": "Get a playlist's tracks by URI or ID",
          "action": "Get a playlist's tracks by URI or ID"
        },
        {
          "name": "Remove an Item",
          "value": "delete",
          "description": "Remove tracks from a playlist by track and playlist URI or ID",
          "action": "Remove an item from a playlist"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search playlists by keyword",
          "action": "Search playlists by keyword"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Playlist ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The playlist's Spotify URI or its ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ],
          "operation": [
            "add",
            "delete",
            "get",
            "getTracks"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the playlist to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "placeholder": "These are all my favorite songs.",
          "description": "Description for the playlist to create"
        },
        {
          "displayName": "Public",
          "name": "public",
          "type": "boolean",
          "default": true,
          "description": "Whether the playlist is publicly accessible"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Track ID",
      "name": "trackID",
      "type": "string",
      "default": "",
      "description": "The track's Spotify URI or its ID. The track to add/delete from the playlist.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ],
          "operation": [
            "add",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Position",
          "name": "position",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "placeholder": "0",
          "description": "The new track's position in the playlist"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Search Keyword",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The keyword term to search for",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "playlist"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "track",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a track by its URI or ID",
          "action": "Get a track"
        },
        {
          "name": "Get Audio Features",
          "value": "getAudioFeatures",
          "description": "Get audio features for a track by URI or ID",
          "action": "Get audio features of a track"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search tracks by keyword",
          "action": "Search tracks by keyword"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Track ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The track's Spotify URI or ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ]
        },
        "hide": {
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Search Keyword",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The keyword term to search for",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getLikedTracks",
      "options": [
        {
          "name": "Get Liked Tracks",
          "value": "getLikedTracks",
          "description": "Get the user's liked tracks",
          "action": "Get liked tracks"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "library"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFollowingArtists",
      "options": [
        {
          "name": "Get Following Artists",
          "value": "getFollowingArtists",
          "description": "Get your followed artists",
          "action": "Get your followed artists"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "myData"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "album",
            "artist",
            "library",
            "myData",
            "playlist",
            "track",
            "player"
          ],
          "operation": [
            "getTracks",
            "getAlbums",
            "getUserPlaylists",
            "getNewReleases",
            "getLikedTracks",
            "getFollowingArtists",
            "search",
            "recentlyPlayed"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "album",
            "artist",
            "library",
            "playlist",
            "track"
          ],
          "operation": [
            "getTracks",
            "getAlbums",
            "getUserPlaylists",
            "getNewReleases",
            "getLikedTracks",
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "myData",
            "player"
          ],
          "operation": [
            "getFollowingArtists",
            "recentlyPlayed"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 50
      }
    },
    {
      "displayName": "Volume",
      "name": "volumePercent",
      "type": "number",
      "default": 50,
      "description": "The volume percentage to set",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "player"
          ],
          "operation": [
            "volume"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country",
          "name": "country",
          "type": "options",
          "default": "US",
          "options": [
            {
              "name": "Afghanistan",
              "value": "AF"
            },
            {
              "name": "Åland Islands",
              "value": "AX"
            },
            {
              "name": "Albania",
              "value": "AL"
            },
            {
              "name": "Algeria",
              "value": "DZ"
            },
            {
              "name": "American Samoa",
              "value": "AS"
            },
            {
              "name": "Andorra",
              "value": "AD"
            },
            {
              "name": "Angola",
              "value": "AO"
            },
            {
              "name": "Anguilla",
              "value": "AI"
            },
            {
              "name": "Antarctica",
              "value": "AQ"
            },
            {
              "name": "Antigua and Barbuda",
              "value": "AG"
            },
            {
              "name": "Argentina",
              "value": "AR"
            },
            {
              "name": "Armenia",
              "value": "AM"
            },
            {
              "name": "Aruba",
              "value": "AW"
            },
            {
              "name": "Australia",
              "value": "AU"
            },
            {
              "name": "Austria",
              "value": "AT"
            },
            {
              "name": "Azerbaijan",
              "value": "AZ"
            },
            {
              "name": "Bahamas (the)",
              "value": "BS"
            },
            {
              "name": "Bahrain",
              "value": "BH"
            },
            {
              "name": "Bangladesh",
              "value": "BD"
            },
            {
              "name": "Barbados",
              "value": "BB"
            },
            {
              "name": "Belarus",
              "value": "BY"
            },
            {
              "name": "Belgium",
              "value": "BE"
            },
            {
              "name": "Belize",
              "value": "BZ"
            },
            {
              "name": "Benin",
              "value": "BJ"
            },
            {
              "name": "Bermuda",
              "value": "BM"
            },
            {
              "name": "Bhutan",
              "value": "BT"
            },
            {
              "name": "Bolivia (Plurinational State of)",
              "value": "BO"
            },
            {
              "name": "Bonaire, Sint Eustatius and Saba",
              "value": "BQ"
            },
            {
              "name": "Bosnia and Herzegovina",
              "value": "BA"
            },
            {
              "name": "Botswana",
              "value": "BW"
            },
            {
              "name": "Bouvet Island",
              "value": "BV"
            },
            {
              "name": "Brazil",
              "value": "BR"
            },
            {
              "name": "British Indian Ocean Territory (the)",
              "value": "IO"
            },
            {
              "name": "Brunei Darussalam",
              "value": "BN"
            },
            {
              "name": "Bulgaria",
              "value": "BG"
            },
            {
              "name": "Burkina Faso",
              "value": "BF"
            },
            {
              "name": "Burundi",
              "value": "BI"
            },
            {
              "name": "Cabo Verde",
              "value": "CV"
            },
            {
              "name": "Cambodia",
              "value": "KH"
            },
            {
              "name": "Cameroon",
              "value": "CM"
            },
            {
              "name": "Canada",
              "value": "CA"
            },
            {
              "name": "Cayman Islands (the)",
              "value": "KY"
            },
            {
              "name": "Central African Republic (the)",
              "value": "CF"
            },
            {
              "name": "Chad",
              "value": "TD"
            },
            {
              "name": "Chile",
              "value": "CL"
            },
            {
              "name": "China",
              "value": "CN"
            },
            {
              "name": "Christmas Island",
              "value": "CX"
            },
            {
              "name": "Cocos (Keeling) Islands (the)",
              "value": "CC"
            },
            {
              "name": "Colombia",
              "value": "CO"
            },
            {
              "name": "Comoros (the)",
              "value": "KM"
            },
            {
              "name": "Congo (the Democratic Republic of the)",
              "value": "CD"
            },
            {
              "name": "Congo (the)",
              "value": "CG"
            },
            {
              "name": "Cook Islands (the)",
              "value": "CK"
            },
            {
              "name": "Costa Rica",
              "value": "CR"
            },
            {
              "name": "Côte d'Ivoire",
              "value": "CI"
            },
            {
              "name": "Croatia",
              "value": "HR"
            },
            {
              "name": "Cuba",
              "value": "CU"
            },
            {
              "name": "Curaçao",
              "value": "CW"
            },
            {
              "name": "Cyprus",
              "value": "CY"
            },
            {
              "name": "Czechia",
              "value": "CZ"
            },
            {
              "name": "Denmark",
              "value": "DK"
            },
            {
              "name": "Djibouti",
              "value": "DJ"
            },
            {
              "name": "Dominica",
              "value": "DM"
            },
            {
              "name": "Dominican Republic (the)",
              "value": "DO"
            },
            {
              "name": "Ecuador",
              "value": "EC"
            },
            {
              "name": "Egypt",
              "value": "EG"
            },
            {
              "name": "El Salvador",
              "value": "SV"
            },
            {
              "name": "Equatorial Guinea",
              "value": "GQ"
            },
            {
              "name": "Eritrea",
              "value": "ER"
            },
            {
              "name": "Estonia",
              "value": "EE"
            },
            {
              "name": "Ethiopia",
              "value": "ET"
            },
            {
              "name": "Falkland Islands (the) [Malvinas]",
              "value": "FK"
            },
            {
              "name": "Faroe Islands (the)",
              "value": "FO"
            },
            {
              "name": "Fiji",
              "value": "FJ"
            },
            {
              "name": "Finland",
              "value": "FI"
            },
            {
              "name": "France",
              "value": "FR"
            },
            {
              "name": "French Guiana",
              "value": "GF"
            },
            {
              "name": "French Polynesia",
              "value": "PF"
            },
            {
              "name": "French Southern Territories (the)",
              "value": "TF"
            },
            {
              "name": "Gabon",
              "value": "GA"
            },
            {
              "name": "Gambia (the)",
              "value": "GM"
            },
            {
              "name": "Georgia",
              "value": "GE"
            },
            {
              "name": "Germany",
              "value": "DE"
            },
            {
              "name": "Ghana",
              "value": "GH"
            },
            {
              "name": "Gibraltar",
              "value": "GI"
            },
            {
              "name": "Greece",
              "value": "GR"
            },
            {
              "name": "Greenland",
              "value": "GL"
            },
            {
              "name": "Grenada",
              "value": "GD"
            },
            {
              "name": "Guadeloupe",
              "value": "GP"
            },
            {
              "name": "Guam",
              "value": "GU"
            },
            {
              "name": "Guatemala",
              "value": "GT"
            },
            {
              "name": "Guernsey",
              "value": "GG"
            },
            {
              "name": "Guinea",
              "value": "GN"
            },
            {
              "name": "Guinea-Bissau",
              "value": "GW"
            },
            {
              "name": "Guyana",
              "value": "GY"
            },
            {
              "name": "Haiti",
              "value": "HT"
            },
            {
              "name": "Heard Island and McDonald Islands",
              "value": "HM"
            },
            {
              "name": "Holy See (the)",
              "value": "VA"
            },
            {
              "name": "Honduras",
              "value": "HN"
            },
            {
              "name": "Hong Kong",
              "value": "HK"
            },
            {
              "name": "Hungary",
              "value": "HU"
            },
            {
              "name": "Iceland",
              "value": "IS"
            },
            {
              "name": "India",
              "value": "IN"
            },
            {
              "name": "Indonesia",
              "value": "ID"
            },
            {
              "name": "Iran (Islamic Republic of)",
              "value": "IR"
            },
            {
              "name": "Iraq",
              "value": "IQ"
            },
            {
              "name": "Ireland",
              "value": "IE"
            },
            {
              "name": "Isle of Man",
              "value": "IM"
            },
            {
              "name": "Israel",
              "value": "IL"
            },
            {
              "name": "Italy",
              "value": "IT"
            },
            {
              "name": "Jamaica",
              "value": "JM"
            },
            {
              "name": "Japan",
              "value": "JP"
            },
            {
              "name": "Jersey",
              "value": "JE"
            },
            {
              "name": "Jordan",
              "value": "JO"
            },
            {
              "name": "Kazakhstan",
              "value": "KZ"
            },
            {
              "name": "Kenya",
              "value": "KE"
            },
            {
              "name": "Kiribati",
              "value": "KI"
            },
            {
              "name": "Korea (the Democratic People's Republic of)",
              "value": "KP"
            },
            {
              "name": "Korea (the Republic of)",
              "value": "KR"
            },
            {
              "name": "Kuwait",
              "value": "KW"
            },
            {
              "name": "Kyrgyzstan",
              "value": "KG"
            },
            {
              "name": "Lao People's Democratic Republic (the)",
              "value": "LA"
            },
            {
              "name": "Latvia",
              "value": "LV"
            },
            {
              "name": "Lebanon",
              "value": "LB"
            },
            {
              "name": "Lesotho",
              "value": "LS"
            },
            {
              "name": "Liberia",
              "value": "LR"
            },
            {
              "name": "Libya",
              "value": "LY"
            },
            {
              "name": "Liechtenstein",
              "value": "LI"
            },
            {
              "name": "Lithuania",
              "value": "LT"
            },
            {
              "name": "Luxembourg",
              "value": "LU"
            },
            {
              "name": "Macao",
              "value": "MO"
            },
            {
              "name": "Macedonia (the former Yugoslav Republic of)",
              "value": "MK"
            },
            {
              "name": "Madagascar",
              "value": "MG"
            },
            {
              "name": "Malawi",
              "value": "MW"
            },
            {
              "name": "Malaysia",
              "value": "MY"
            },
            {
              "name": "Maldives",
              "value": "MV"
            },
            {
              "name": "Mali",
              "value": "ML"
            },
            {
              "name": "Malta",
              "value": "MT"
            },
            {
              "name": "Marshall Islands (the)",
              "value": "MH"
            },
            {
              "name": "Martinique",
              "value": "MQ"
            },
            {
              "name": "Mauritania",
              "value": "MR"
            },
            {
              "name": "Mauritius",
              "value": "MU"
            },
            {
              "name": "Mayotte",
              "value": "YT"
            },
            {
              "name": "Mexico",
              "value": "MX"
            },
            {
              "name": "Micronesia (Federated States of)",
              "value": "FM"
            },
            {
              "name": "Moldova (the Republic of)",
              "value": "MD"
            },
            {
              "name": "Monaco",
              "value": "MC"
            },
            {
              "name": "Mongolia",
              "value": "MN"
            },
            {
              "name": "Montenegro",
              "value": "ME"
            },
            {
              "name": "Montserrat",
              "value": "MS"
            },
            {
              "name": "Morocco",
              "value": "MA"
            },
            {
              "name": "Mozambique",
              "value": "MZ"
            },
            {
              "name": "Myanmar",
              "value": "MM"
            },
            {
              "name": "Namibia",
              "value": "NA"
            },
            {
              "name": "Nauru",
              "value": "NR"
            },
            {
              "name": "Nepal",
              "value": "NP"
            },
            {
              "name": "Netherlands (the)",
              "value": "NL"
            },
            {
              "name": "New Caledonia",
              "value": "NC"
            },
            {
              "name": "New Zealand",
              "value": "NZ"
            },
            {
              "name": "Nicaragua",
              "value": "NI"
            },
            {
              "name": "Niger (the)",
              "value": "NE"
            },
            {
              "name": "Nigeria",
              "value": "NG"
            },
            {
              "name": "Niue",
              "value": "NU"
            },
            {
              "name": "Norfolk Island",
              "value": "NF"
            },
            {
              "name": "Northern Mariana Islands (the)",
              "value": "MP"
            },
            {
              "name": "Norway",
              "value": "NO"
            },
            {
              "name": "Oman",
              "value": "OM"
            },
            {
              "name": "Pakistan",
              "value": "PK"
            },
            {
              "name": "Palau",
              "value": "PW"
            },
            {
              "name": "Palestine, State of",
              "value": "PS"
            },
            {
              "name": "Panama",
              "value": "PA"
            },
            {
              "name": "Papua New Guinea",
              "value": "PG"
            },
            {
              "name": "Paraguay",
              "value": "PY"
            },
            {
              "name": "Peru",
              "value": "PE"
            },
            {
              "name": "Philippines (the)",
              "value": "PH"
            },
            {
              "name": "Pitcairn",
              "value": "PN"
            },
            {
              "name": "Poland",
              "value": "PL"
            },
            {
              "name": "Portugal",
              "value": "PT"
            },
            {
              "name": "Puerto Rico",
              "value": "PR"
            },
            {
              "name": "Qatar",
              "value": "QA"
            },
            {
              "name": "Réunion",
              "value": "RE"
            },
            {
              "name": "Romania",
              "value": "RO"
            },
            {
              "name": "Russian Federation (the)",
              "value": "RU"
            },
            {
              "name": "Rwanda",
              "value": "RW"
            },
            {
              "name": "Saint Barthélemy",
              "value": "BL"
            },
            {
              "name": "Saint Helena, Ascension and Tristan da Cunha",
              "value": "SH"
            },
            {
              "name": "Saint Kitts and Nevis",
              "value": "KN"
            },
            {
              "name": "Saint Lucia",
              "value": "LC"
            },
            {
              "name": "Saint Martin (French part)",
              "value": "MF"
            },
            {
              "name": "Saint Pierre and Miquelon",
              "value": "PM"
            },
            {
              "name": "Saint Vincent and the Grenadines",
              "value": "VC"
            },
            {
              "name": "Samoa",
              "value": "WS"
            },
            {
              "name": "San Marino",
              "value": "SM"
            },
            {
              "name": "Sao Tome and Principe",
              "value": "ST"
            },
            {
              "name": "Saudi Arabia",
              "value": "SA"
            },
            {
              "name": "Senegal",
              "value": "SN"
            },
            {
              "name": "Serbia",
              "value": "RS"
            },
            {
              "name": "Seychelles",
              "value": "SC"
            },
            {
              "name": "Sierra Leone",
              "value": "SL"
            },
            {
              "name": "Singapore",
              "value": "SG"
            },
            {
              "name": "Sint Maarten (Dutch part)",
              "value": "SX"
            },
            {
              "name": "Slovakia",
              "value": "SK"
            },
            {
              "name": "Slovenia",
              "value": "SI"
            },
            {
              "name": "Solomon Islands",
              "value": "SB"
            },
            {
              "name": "Somalia",
              "value": "SO"
            },
            {
              "name": "South Africa",
              "value": "ZA"
            },
            {
              "name": "South Georgia and the South Sandwich Islands",
              "value": "GS"
            },
            {
              "name": "South Sudan",
              "value": "SS"
            },
            {
              "name": "Spain",
              "value": "ES"
            },
            {
              "name": "Sri Lanka",
              "value": "LK"
            },
            {
              "name": "Sudan (the)",
              "value": "SD"
            },
            {
              "name": "Suriname",
              "value": "SR"
            },
            {
              "name": "Svalbard and Jan Mayen",
              "value": "SJ"
            },
            {
              "name": "Swaziland",
              "value": "SZ"
            },
            {
              "name": "Sweden",
              "value": "SE"
            },
            {
              "name": "Switzerland",
              "value": "CH"
            },
            {
              "name": "Syrian Arab Republic",
              "value": "SY"
            },
            {
              "name": "Taiwan (Province of China)",
              "value": "TW"
            },
            {
              "name": "Tajikistan",
              "value": "TJ"
            },
            {
              "name": "Tanzania, United Republic of",
              "value": "TZ"
            },
            {
              "name": "Thailand",
              "value": "TH"
            },
            {
              "name": "Timor-Leste",
              "value": "TL"
            },
            {
              "name": "Togo",
              "value": "TG"
            },
            {
              "name": "Tokelau",
              "value": "TK"
            },
            {
              "name": "Tonga",
              "value": "TO"
            },
            {
              "name": "Trinidad and Tobago",
              "value": "TT"
            },
            {
              "name": "Tunisia",
              "value": "TN"
            },
            {
              "name": "Turkey",
              "value": "TR"
            },
            {
              "name": "Turkmenistan",
              "value": "TM"
            },
            {
              "name": "Turks and Caicos Islands (the)",
              "value": "TC"
            },
            {
              "name": "Tuvalu",
              "value": "TV"
            },
            {
              "name": "Uganda",
              "value": "UG"
            },
            {
              "name": "Ukraine",
              "value": "UA"
            },
            {
              "name": "United Arab Emirates (the)",
              "value": "AE"
            },
            {
              "name": "United Kingdom of Great Britain and Northern Ireland (the)",
              "value": "GB"
            },
            {
              "name": "United States Minor Outlying Islands (the)",
              "value": "UM"
            },
            {
              "name": "United States of America (the)",
              "value": "US"
            },
            {
              "name": "Uruguay",
              "value": "UY"
            },
            {
              "name": "Uzbekistan",
              "value": "UZ"
            },
            {
              "name": "Vanuatu",
              "value": "VU"
            },
            {
              "name": "Venezuela (Bolivarian Republic of)",
              "value": "VE"
            },
            {
              "name": "Viet Nam",
              "value": "VN"
            },
            {
              "name": "Virgin Islands (British)",
              "value": "VG"
            },
            {
              "name": "Virgin Islands (U.S.)",
              "value": "VI"
            },
            {
              "name": "Wallis and Futuna",
              "value": "WF"
            },
            {
              "name": "Western Sahara*",
              "value": "EH"
            },
            {
              "name": "Yemen",
              "value": "YE"
            },
            {
              "name": "Zambia",
              "value": "ZM"
            },
            {
              "name": "Zimbabwe",
              "value": "ZW"
            }
          ],
          "description": "Country to filter new releases by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "album"
          ],
          "operation": [
            "getNewReleases"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country",
          "name": "market",
          "type": "options",
          "options": [
            {
              "name": "Afghanistan",
              "value": "AF"
            },
            {
              "name": "Åland Islands",
              "value": "AX"
            },
            {
              "name": "Albania",
              "value": "AL"
            },
            {
              "name": "Algeria",
              "value": "DZ"
            },
            {
              "name": "American Samoa",
              "value": "AS"
            },
            {
              "name": "Andorra",
              "value": "AD"
            },
            {
              "name": "Angola",
              "value": "AO"
            },
            {
              "name": "Anguilla",
              "value": "AI"
            },
            {
              "name": "Antarctica",
              "value": "AQ"
            },
            {
              "name": "Antigua and Barbuda",
              "value": "AG"
            },
            {
              "name": "Argentina",
              "value": "AR"
            },
            {
              "name": "Armenia",
              "value": "AM"
            },
            {
              "name": "Aruba",
              "value": "AW"
            },
            {
              "name": "Australia",
              "value": "AU"
            },
            {
              "name": "Austria",
              "value": "AT"
            },
            {
              "name": "Azerbaijan",
              "value": "AZ"
            },
            {
              "name": "Bahamas (the)",
              "value": "BS"
            },
            {
              "name": "Bahrain",
              "value": "BH"
            },
            {
              "name": "Bangladesh",
              "value": "BD"
            },
            {
              "name": "Barbados",
              "value": "BB"
            },
            {
              "name": "Belarus",
              "value": "BY"
            },
            {
              "name": "Belgium",
              "value": "BE"
            },
            {
              "name": "Belize",
              "value": "BZ"
            },
            {
              "name": "Benin",
              "value": "BJ"
            },
            {
              "name": "Bermuda",
              "value": "BM"
            },
            {
              "name": "Bhutan",
              "value": "BT"
            },
            {
              "name": "Bolivia (Plurinational State of)",
              "value": "BO"
            },
            {
              "name": "Bonaire, Sint Eustatius and Saba",
              "value": "BQ"
            },
            {
              "name": "Bosnia and Herzegovina",
              "value": "BA"
            },
            {
              "name": "Botswana",
              "value": "BW"
            },
            {
              "name": "Bouvet Island",
              "value": "BV"
            },
            {
              "name": "Brazil",
              "value": "BR"
            },
            {
              "name": "British Indian Ocean Territory (the)",
              "value": "IO"
            },
            {
              "name": "Brunei Darussalam",
              "value": "BN"
            },
            {
              "name": "Bulgaria",
              "value": "BG"
            },
            {
              "name": "Burkina Faso",
              "value": "BF"
            },
            {
              "name": "Burundi",
              "value": "BI"
            },
            {
              "name": "Cabo Verde",
              "value": "CV"
            },
            {
              "name": "Cambodia",
              "value": "KH"
            },
            {
              "name": "Cameroon",
              "value": "CM"
            },
            {
              "name": "Canada",
              "value": "CA"
            },
            {
              "name": "Cayman Islands (the)",
              "value": "KY"
            },
            {
              "name": "Central African Republic (the)",
              "value": "CF"
            },
            {
              "name": "Chad",
              "value": "TD"
            },
            {
              "name": "Chile",
              "value": "CL"
            },
            {
              "name": "China",
              "value": "CN"
            },
            {
              "name": "Christmas Island",
              "value": "CX"
            },
            {
              "name": "Cocos (Keeling) Islands (the)",
              "value": "CC"
            },
            {
              "name": "Colombia",
              "value": "CO"
            },
            {
              "name": "Comoros (the)",
              "value": "KM"
            },
            {
              "name": "Congo (the Democratic Republic of the)",
              "value": "CD"
            },
            {
              "name": "Congo (the)",
              "value": "CG"
            },
            {
              "name": "Cook Islands (the)",
              "value": "CK"
            },
            {
              "name": "Costa Rica",
              "value": "CR"
            },
            {
              "name": "Côte d'Ivoire",
              "value": "CI"
            },
            {
              "name": "Croatia",
              "value": "HR"
            },
            {
              "name": "Cuba",
              "value": "CU"
            },
            {
              "name": "Curaçao",
              "value": "CW"
            },
            {
              "name": "Cyprus",
              "value": "CY"
            },
            {
              "name": "Czechia",
              "value": "CZ"
            },
            {
              "name": "Denmark",
              "value": "DK"
            },
            {
              "name": "Djibouti",
              "value": "DJ"
            },
            {
              "name": "Dominica",
              "value": "DM"
            },
            {
              "name": "Dominican Republic (the)",
              "value": "DO"
            },
            {
              "name": "Ecuador",
              "value": "EC"
            },
            {
              "name": "Egypt",
              "value": "EG"
            },
            {
              "name": "El Salvador",
              "value": "SV"
            },
            {
              "name": "Equatorial Guinea",
              "value": "GQ"
            },
            {
              "name": "Eritrea",
              "value": "ER"
            },
            {
              "name": "Estonia",
              "value": "EE"
            },
            {
              "name": "Ethiopia",
              "value": "ET"
            },
            {
              "name": "Falkland Islands (the) [Malvinas]",
              "value": "FK"
            },
            {
              "name": "Faroe Islands (the)",
              "value": "FO"
            },
            {
              "name": "Fiji",
              "value": "FJ"
            },
            {
              "name": "Finland",
              "value": "FI"
            },
            {
              "name": "France",
              "value": "FR"
            },
            {
              "name": "French Guiana",
              "value": "GF"
            },
            {
              "name": "French Polynesia",
              "value": "PF"
            },
            {
              "name": "French Southern Territories (the)",
              "value": "TF"
            },
            {
              "name": "Gabon",
              "value": "GA"
            },
            {
              "name": "Gambia (the)",
              "value": "GM"
            },
            {
              "name": "Georgia",
              "value": "GE"
            },
            {
              "name": "Germany",
              "value": "DE"
            },
            {
              "name": "Ghana",
              "value": "GH"
            },
            {
              "name": "Gibraltar",
              "value": "GI"
            },
            {
              "name": "Greece",
              "value": "GR"
            },
            {
              "name": "Greenland",
              "value": "GL"
            },
            {
              "name": "Grenada",
              "value": "GD"
            },
            {
              "name": "Guadeloupe",
              "value": "GP"
            },
            {
              "name": "Guam",
              "value": "GU"
            },
            {
              "name": "Guatemala",
              "value": "GT"
            },
            {
              "name": "Guernsey",
              "value": "GG"
            },
            {
              "name": "Guinea",
              "value": "GN"
            },
            {
              "name": "Guinea-Bissau",
              "value": "GW"
            },
            {
              "name": "Guyana",
              "value": "GY"
            },
            {
              "name": "Haiti",
              "value": "HT"
            },
            {
              "name": "Heard Island and McDonald Islands",
              "value": "HM"
            },
            {
              "name": "Holy See (the)",
              "value": "VA"
            },
            {
              "name": "Honduras",
              "value": "HN"
            },
            {
              "name": "Hong Kong",
              "value": "HK"
            },
            {
              "name": "Hungary",
              "value": "HU"
            },
            {
              "name": "Iceland",
              "value": "IS"
            },
            {
              "name": "India",
              "value": "IN"
            },
            {
              "name": "Indonesia",
              "value": "ID"
            },
            {
              "name": "Iran (Islamic Republic of)",
              "value": "IR"
            },
            {
              "name": "Iraq",
              "value": "IQ"
            },
            {
              "name": "Ireland",
              "value": "IE"
            },
            {
              "name": "Isle of Man",
              "value": "IM"
            },
            {
              "name": "Israel",
              "value": "IL"
            },
            {
              "name": "Italy",
              "value": "IT"
            },
            {
              "name": "Jamaica",
              "value": "JM"
            },
            {
              "name": "Japan",
              "value": "JP"
            },
            {
              "name": "Jersey",
              "value": "JE"
            },
            {
              "name": "Jordan",
              "value": "JO"
            },
            {
              "name": "Kazakhstan",
              "value": "KZ"
            },
            {
              "name": "Kenya",
              "value": "KE"
            },
            {
              "name": "Kiribati",
              "value": "KI"
            },
            {
              "name": "Korea (the Democratic People's Republic of)",
              "value": "KP"
            },
            {
              "name": "Korea (the Republic of)",
              "value": "KR"
            },
            {
              "name": "Kuwait",
              "value": "KW"
            },
            {
              "name": "Kyrgyzstan",
              "value": "KG"
            },
            {
              "name": "Lao People's Democratic Republic (the)",
              "value": "LA"
            },
            {
              "name": "Latvia",
              "value": "LV"
            },
            {
              "name": "Lebanon",
              "value": "LB"
            },
            {
              "name": "Lesotho",
              "value": "LS"
            },
            {
              "name": "Liberia",
              "value": "LR"
            },
            {
              "name": "Libya",
              "value": "LY"
            },
            {
              "name": "Liechtenstein",
              "value": "LI"
            },
            {
              "name": "Lithuania",
              "value": "LT"
            },
            {
              "name": "Luxembourg",
              "value": "LU"
            },
            {
              "name": "Macao",
              "value": "MO"
            },
            {
              "name": "Macedonia (the former Yugoslav Republic of)",
              "value": "MK"
            },
            {
              "name": "Madagascar",
              "value": "MG"
            },
            {
              "name": "Malawi",
              "value": "MW"
            },
            {
              "name": "Malaysia",
              "value": "MY"
            },
            {
              "name": "Maldives",
              "value": "MV"
            },
            {
              "name": "Mali",
              "value": "ML"
            },
            {
              "name": "Malta",
              "value": "MT"
            },
            {
              "name": "Marshall Islands (the)",
              "value": "MH"
            },
            {
              "name": "Martinique",
              "value": "MQ"
            },
            {
              "name": "Mauritania",
              "value": "MR"
            },
            {
              "name": "Mauritius",
              "value": "MU"
            },
            {
              "name": "Mayotte",
              "value": "YT"
            },
            {
              "name": "Mexico",
              "value": "MX"
            },
            {
              "name": "Micronesia (Federated States of)",
              "value": "FM"
            },
            {
              "name": "Moldova (the Republic of)",
              "value": "MD"
            },
            {
              "name": "Monaco",
              "value": "MC"
            },
            {
              "name": "Mongolia",
              "value": "MN"
            },
            {
              "name": "Montenegro",
              "value": "ME"
            },
            {
              "name": "Montserrat",
              "value": "MS"
            },
            {
              "name": "Morocco",
              "value": "MA"
            },
            {
              "name": "Mozambique",
              "value": "MZ"
            },
            {
              "name": "Myanmar",
              "value": "MM"
            },
            {
              "name": "Namibia",
              "value": "NA"
            },
            {
              "name": "Nauru",
              "value": "NR"
            },
            {
              "name": "Nepal",
              "value": "NP"
            },
            {
              "name": "Netherlands (the)",
              "value": "NL"
            },
            {
              "name": "New Caledonia",
              "value": "NC"
            },
            {
              "name": "New Zealand",
              "value": "NZ"
            },
            {
              "name": "Nicaragua",
              "value": "NI"
            },
            {
              "name": "Niger (the)",
              "value": "NE"
            },
            {
              "name": "Nigeria",
              "value": "NG"
            },
            {
              "name": "Niue",
              "value": "NU"
            },
            {
              "name": "Norfolk Island",
              "value": "NF"
            },
            {
              "name": "Northern Mariana Islands (the)",
              "value": "MP"
            },
            {
              "name": "Norway",
              "value": "NO"
            },
            {
              "name": "Oman",
              "value": "OM"
            },
            {
              "name": "Pakistan",
              "value": "PK"
            },
            {
              "name": "Palau",
              "value": "PW"
            },
            {
              "name": "Palestine, State of",
              "value": "PS"
            },
            {
              "name": "Panama",
              "value": "PA"
            },
            {
              "name": "Papua New Guinea",
              "value": "PG"
            },
            {
              "name": "Paraguay",
              "value": "PY"
            },
            {
              "name": "Peru",
              "value": "PE"
            },
            {
              "name": "Philippines (the)",
              "value": "PH"
            },
            {
              "name": "Pitcairn",
              "value": "PN"
            },
            {
              "name": "Poland",
              "value": "PL"
            },
            {
              "name": "Portugal",
              "value": "PT"
            },
            {
              "name": "Puerto Rico",
              "value": "PR"
            },
            {
              "name": "Qatar",
              "value": "QA"
            },
            {
              "name": "Réunion",
              "value": "RE"
            },
            {
              "name": "Romania",
              "value": "RO"
            },
            {
              "name": "Russian Federation (the)",
              "value": "RU"
            },
            {
              "name": "Rwanda",
              "value": "RW"
            },
            {
              "name": "Saint Barthélemy",
              "value": "BL"
            },
            {
              "name": "Saint Helena, Ascension and Tristan da Cunha",
              "value": "SH"
            },
            {
              "name": "Saint Kitts and Nevis",
              "value": "KN"
            },
            {
              "name": "Saint Lucia",
              "value": "LC"
            },
            {
              "name": "Saint Martin (French part)",
              "value": "MF"
            },
            {
              "name": "Saint Pierre and Miquelon",
              "value": "PM"
            },
            {
              "name": "Saint Vincent and the Grenadines",
              "value": "VC"
            },
            {
              "name": "Samoa",
              "value": "WS"
            },
            {
              "name": "San Marino",
              "value": "SM"
            },
            {
              "name": "Sao Tome and Principe",
              "value": "ST"
            },
            {
              "name": "Saudi Arabia",
              "value": "SA"
            },
            {
              "name": "Senegal",
              "value": "SN"
            },
            {
              "name": "Serbia",
              "value": "RS"
            },
            {
              "name": "Seychelles",
              "value": "SC"
            },
            {
              "name": "Sierra Leone",
              "value": "SL"
            },
            {
              "name": "Singapore",
              "value": "SG"
            },
            {
              "name": "Sint Maarten (Dutch part)",
              "value": "SX"
            },
            {
              "name": "Slovakia",
              "value": "SK"
            },
            {
              "name": "Slovenia",
              "value": "SI"
            },
            {
              "name": "Solomon Islands",
              "value": "SB"
            },
            {
              "name": "Somalia",
              "value": "SO"
            },
            {
              "name": "South Africa",
              "value": "ZA"
            },
            {
              "name": "South Georgia and the South Sandwich Islands",
              "value": "GS"
            },
            {
              "name": "South Sudan",
              "value": "SS"
            },
            {
              "name": "Spain",
              "value": "ES"
            },
            {
              "name": "Sri Lanka",
              "value": "LK"
            },
            {
              "name": "Sudan (the)",
              "value": "SD"
            },
            {
              "name": "Suriname",
              "value": "SR"
            },
            {
              "name": "Svalbard and Jan Mayen",
              "value": "SJ"
            },
            {
              "name": "Swaziland",
              "value": "SZ"
            },
            {
              "name": "Sweden",
              "value": "SE"
            },
            {
              "name": "Switzerland",
              "value": "CH"
            },
            {
              "name": "Syrian Arab Republic",
              "value": "SY"
            },
            {
              "name": "Taiwan (Province of China)",
              "value": "TW"
            },
            {
              "name": "Tajikistan",
              "value": "TJ"
            },
            {
              "name": "Tanzania, United Republic of",
              "value": "TZ"
            },
            {
              "name": "Thailand",
              "value": "TH"
            },
            {
              "name": "Timor-Leste",
              "value": "TL"
            },
            {
              "name": "Togo",
              "value": "TG"
            },
            {
              "name": "Tokelau",
              "value": "TK"
            },
            {
              "name": "Tonga",
              "value": "TO"
            },
            {
              "name": "Trinidad and Tobago",
              "value": "TT"
            },
            {
              "name": "Tunisia",
              "value": "TN"
            },
            {
              "name": "Turkey",
              "value": "TR"
            },
            {
              "name": "Turkmenistan",
              "value": "TM"
            },
            {
              "name": "Turks and Caicos Islands (the)",
              "value": "TC"
            },
            {
              "name": "Tuvalu",
              "value": "TV"
            },
            {
              "name": "Uganda",
              "value": "UG"
            },
            {
              "name": "Ukraine",
              "value": "UA"
            },
            {
              "name": "United Arab Emirates (the)",
              "value": "AE"
            },
            {
              "name": "United Kingdom of Great Britain and Northern Ireland (the)",
              "value": "GB"
            },
            {
              "name": "United States Minor Outlying Islands (the)",
              "value": "UM"
            },
            {
              "name": "United States of America (the)",
              "value": "US"
            },
            {
              "name": "Uruguay",
              "value": "UY"
            },
            {
              "name": "Uzbekistan",
              "value": "UZ"
            },
            {
              "name": "Vanuatu",
              "value": "VU"
            },
            {
              "name": "Venezuela (Bolivarian Republic of)",
              "value": "VE"
            },
            {
              "name": "Viet Nam",
              "value": "VN"
            },
            {
              "name": "Virgin Islands (British)",
              "value": "VG"
            },
            {
              "name": "Virgin Islands (U.S.)",
              "value": "VI"
            },
            {
              "name": "Wallis and Futuna",
              "value": "WF"
            },
            {
              "name": "Western Sahara*",
              "value": "EH"
            },
            {
              "name": "Yemen",
              "value": "YE"
            },
            {
              "name": "Zambia",
              "value": "ZM"
            },
            {
              "name": "Zimbabwe",
              "value": "ZW"
            }
          ],
          "default": "",
          "description": "If a country code is specified, only content that is playable in that market is returned"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "playlist",
            "artist",
            "track",
            "album"
          ],
          "operation": [
            "search"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "addSongToQueue",
      "name": "Add Song to Queue",
      "description": "Add a song to your queue"
    },
    {
      "operation": "currentlyPlaying",
      "name": "Currently Playing",
      "description": "Get your currently playing track"
    },
    {
      "operation": "nextSong",
      "name": "Next Song",
      "description": "Skip to your next track"
    },
    {
      "operation": "pause",
      "name": "Pause",
      "description": "Pause your music"
    },
    {
      "operation": "previousSong",
      "name": "Previous Song",
      "description": "Skip to your previous song"
    },
    {
      "operation": "recentlyPlayed",
      "name": "Recently Played",
      "description": "Get your recently played tracks"
    },
    {
      "operation": "resume",
      "name": "Resume",
      "description": "Resume playback on the current active device"
    },
    {
      "operation": "volume",
      "name": "Set Volume",
      "description": "Set volume on the current active device"
    },
    {
      "operation": "startMusic",
      "name": "Start Music",
      "description": "Start playing a playlist, artist, or album"
    }
  ]


node_type: nodes-base.spreadsheetFile
package_name: n8n-nodes-base
display_name: Spreadsheet File
description: Reads and writes data from a spreadsheet file like CSV, XLS, ODS, etc
category: transform
development_style: programmatic
version: 2
credentials_required: []
updated_at: 2025-06-18 20:35:39
properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "fromFile",
      "options": [
        {
          "name": "Read From File",
          "value": "fromFile",
          "description": "Reads data from a spreadsheet file",
          "action": "Read data from a spreadsheet file"
        },
        {
          "name": "Write to File",
          "value": "toFile",
          "description": "Writes the workflow data to a spreadsheet file",
          "action": "Write data to a spreadsheet file"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "fromFile"
          ]
        }
      }
    },
    {
      "displayName": "File Format",
      "name": "fileFormat",
      "type": "options",
      "default": "autodetect",
      "description": "The format of the binary data to read from",
      "options": [
        {
          "name": "Autodetect",
          "value": "autodetect"
        },
        {
          "name": "CSV",
          "value": "csv",
          "description": "Comma-separated values"
        },
        {
          "name": "HTML",
          "value": "html",
          "description": "HTML Table"
        },
        {
          "name": "ODS",
          "value": "ods",
          "description": "OpenDocument Spreadsheet"
        },
        {
          "name": "RTF",
          "value": "rtf",
          "description": "Rich Text Format"
        },
        {
          "name": "XLS",
          "value": "xls",
          "description": "Excel"
        },
        {
          "name": "XLSX",
          "value": "xlsx",
          "description": "Excel"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "fromFile"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delimiter",
          "name": "delimiter",
          "type": "string",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          },
          "default": ",",
          "placeholder": "e.g. ,",
          "description": "Set the field delimiter, usually a comma"
        },
        {
          "displayName": "Encoding",
          "name": "encoding",
          "type": "options",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          },
          "options": [
            {
              "name": "ASCII",
              "value": "ascii"
            },
            {
              "name": "Latin1",
              "value": "latin1"
            },
            {
              "name": "UCS-2",
              "value": "ucs-2"
            },
            {
              "name": "UCS2",
              "value": "ucs2"
            },
            {
              "name": "UTF-8",
              "value": "utf-8"
            },
            {
              "name": "UTF16LE",
              "value": "utf16le"
            },
            {
              "name": "UTF8",
              "value": "utf8"
            }
          ],
          "default": "utf-8"
        },
        {
          "displayName": "Exclude Byte Order Mark (BOM)",
          "name": "enableBOM",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          },
          "default": false,
          "description": "Whether to detect and exclude the byte-order-mark from the CSV Input if present"
        },
        {
          "displayName": "Preserve Quotes",
          "name": "relaxQuotes",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          },
          "default": false,
          "description": "Whether to handle unclosed quotes in CSV fields as part of the field's content instead of throwing a parsing error"
        },
        {
          "displayName": "Header Row",
          "name": "headerRow",
          "type": "boolean",
          "default": true,
          "description": "Whether the first row of the file contains the header names"
        },
        {
          "displayName": "Include Empty Cells",
          "name": "includeEmptyCells",
          "type": "boolean",
          "default": false,
          "description": "Whether to include empty cells when reading from file. They will be filled with an empty string."
        },
        {
          "displayName": "Max Number of Rows to Load",
          "name": "maxRowCount",
          "type": "number",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          },
          "default": -1,
          "placeholder": "e.g. 10",
          "description": "Stop handling records after the requested number of rows are read. Use -1 if you want to load all rows."
        },
        {
          "displayName": "Range",
          "name": "range",
          "type": "string",
          "default": "",
          "description": "The range to read from the table. If set to a number it will be the starting row. If set to string it will be used as A1-style notation range."
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether to return RAW data, instead of parsing it"
        },
        {
          "displayName": "Read As String",
          "name": "readAsString",
          "type": "boolean",
          "default": false,
          "description": "In some cases and file formats, it is necessary to read as string to ensure special characters are interpreted correctly"
        },
        {
          "displayName": "Sheet Name",
          "name": "sheetName",
          "type": "string",
          "default": "Sheet",
          "placeholder": "e.g. mySheet",
          "description": "Name of the sheet to read from in the spreadsheet (if supported). If not set, the first one will be chosen."
        },
        {
          "displayName": "Starting Line",
          "name": "fromLine",
          "type": "number",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          },
          "default": 0,
          "placeholder": "e.g. 0",
          "description": "Start handling records from the requested line number. Starts at 0."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "fromFile"
          ]
        }
      }
    },
    {
      "displayName": "File Format",
      "name": "fileFormat",
      "type": "options",
      "default": "xls",
      "description": "The format of the file to save the data as",
      "options": [
        {
          "name": "CSV",
          "value": "csv",
          "description": "Comma-separated values"
        },
        {
          "name": "HTML",
          "value": "html",
          "description": "HTML Table"
        },
        {
          "name": "ODS",
          "value": "ods",
          "description": "OpenDocument Spreadsheet"
        },
        {
          "name": "RTF",
          "value": "rtf",
          "description": "Rich Text Format"
        },
        {
          "name": "XLS",
          "value": "xls",
          "description": "Excel"
        },
        {
          "name": "XLSX",
          "value": "xlsx",
          "description": "Excel"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "toFile"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "toFile"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Compression",
          "name": "compression",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "xlsx",
                "ods"
              ]
            }
          },
          "default": false,
          "description": "Whether compression will be applied or not"
        },
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "File name to set in binary data. By default will \"spreadsheet.&lt;fileFormat&gt;\" be used."
        },
        {
          "displayName": "Header Row",
          "name": "headerRow",
          "type": "boolean",
          "default": true,
          "description": "Whether the first row of the file contains the header names"
        },
        {
          "displayName": "Sheet Name",
          "name": "sheetName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "ods",
                "xls",
                "xlsx"
              ]
            }
          },
          "default": "Sheet",
          "description": "Name of the sheet to create in the spreadsheet"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "toFile"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "fromFile",
      "name": "Read From File",
      "description": "Reads data from a spreadsheet file"
    },
    {
      "operation": "toFile",
      "name": "Write to File",
      "description": "Writes the workflow data to a spreadsheet file"
    }
  ]


node_type: nodes-base.sseTrigger
package_name: n8n-nodes-base
display_name: SSE Trigger
description: Triggers the workflow when Server-Sent Events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SSE Trigger node documentation
  description: Learn how to use the SSE Trigger node in n8n. Follow technical documentation to integrate SSE Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # SSE Trigger node

  Server-Sent Events (SSE) is a server push technology enabling a client to receive automatic updates from a server using HTTP connection. The SSE Trigger node is used to receive server-sent events.

  ## Node parameters

  The SSE Trigger node has one parameter, the **URL**. Enter the URL from which to receive the server-sent events (SSE).


  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "The URL to receive the SSE from",
      "required": true
    }
  ]


node_type: nodes-base.ssh
package_name: n8n-nodes-base
display_name: SSH
description: Execute commands via SSH
category: input
development_style: programmatic
version: 1
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SSH
  description: Documentation for the SSH node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # SSH

  The SSH node is useful for executing commands using the Secure Shell Protocol.

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

  ## Operations

  - [**Execute** a command](#execute-command)
  - [**Download** a file](#download-file)
  - [**Upload** a file](#upload-file)

  /// note | Uploading files
  To attach a file for upload, you will need to use an extra node such as the [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) node or the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node to pass the file as a data property.
  ///

  ### Execute Command

  Configure this operation with these parameters:

  - **Credential to connect with**: Select an existing or create a new [SSH credential](/integrations/builtin/credentials/ssh.md) to connect with.
  - **Command**: Enter the command to execute on the remote device.
  - **Working Directory**: Enter the directory where n8n should execute the command.

  ### Download File

  - **Credential to connect with**: Select an existing or create a new [SSH credential](/integrations/builtin/credentials/ssh.md) to connect with.
  - **Path**: Enter the path for the file you want to download. This path must include the file name. The downloaded file will use this file name. To use a different name, use the **File Name** option. Refer to [Download File options](#download-file-options) for more information.
  - **File Property**: Enter the name of the object property that holds the binary data you want to download.

  #### Download File options

  You can further configure this operation with the **File Name** option. Use this option to override the binary data file name to a name of your choice.

  ### Upload File

  - **Credential to connect with**: Select an existing or create a new [SSH credential](/integrations/builtin/credentials/ssh.md) to connect with.
  - **Input Binary Field**: Enter the name of the input binary field that contains the file you want to upload.
  - **Target Directory**: The directory to upload the file to. The name of the file is taken from the binary data file name. To enter a different name, use the **File Name** option. Refer to [Upload File options](#upload-file-options) for more information.

  #### Upload File options

  You can further configure this operation with the **File Name** option. Use this option to override the binary data file name to a name of your choice.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "password",
      "options": [
        {
          "name": "Password",
          "value": "password"
        },
        {
          "name": "Private Key",
          "value": "privateKey"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "command",
      "options": [
        {
          "name": "Command",
          "value": "command"
        },
        {
          "name": "File",
          "value": "file"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "execute",
      "options": [
        {
          "name": "Execute",
          "value": "execute",
          "description": "Execute a command",
          "action": "Execute a command"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "command"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Command",
      "name": "command",
      "type": "string",
      "default": "",
      "description": "The command to be executed on a remote device",
      "displayOptions": {
        "show": {
          "resource": [
            "command"
          ],
          "operation": [
            "execute"
          ]
        }
      }
    },
    {
      "displayName": "Working Directory",
      "name": "cwd",
      "type": "string",
      "default": "/",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "command"
          ],
          "operation": [
            "execute"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Download",
          "value": "download",
          "description": "Download a file",
          "action": "Download a file"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload a file",
          "action": "Upload a file"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Target Directory",
      "name": "path",
      "type": "string",
      "default": "",
      "description": "The directory to upload the file to. The name of the file does not need to be specified, it's taken from the binary data file name. To override this behavior, set the parameter \"File Name\" under options.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Path",
      "name": "path",
      "type": "string",
      "default": "",
      "description": "The file path of the file to download. Has to contain the full path including file name.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "File Property",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "Object property name which holds binary data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "Overrides the binary data file name"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload",
            "download"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "execute",
      "name": "Execute",
      "description": "Execute a command"
    }
  ]

credentials_required:
  [
    {
      "name": "sshPassword",
      "required": true,
      "testedBy": "sshConnectionTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "password"
          ]
        }
      }
    },
    {
      "name": "sshPrivateKey",
      "required": true,
      "testedBy": "sshConnectionTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "privateKey"
          ]
        }
      }
    }
  ]


node_type: nodes-base.stackby
package_name: n8n-nodes-base
display_name: Stackby
description: Read, write, and delete data in Stackby
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "stackbyApi",
  "required": true
  }
  ]

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Stackby node documentation
  description: Learn how to use the Stackby node in n8n. Follow technical documentation to integrate Stackby node into your workflows.
  contentType: [integration, reference]
  ---

  # Stackby node

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

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

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

  ## Operations

  - Append
  - Delete
  - List
  - Read

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "append",
      "options": [
        {
          "name": "Append",
          "value": "append"
        },
        {
          "name": "Delete",
          "value": "delete"
        },
        {
          "name": "List",
          "value": "list"
        },
        {
          "name": "Read",
          "value": "read"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Stack ID",
      "name": "stackId",
      "type": "string",
      "default": "",
      "description": "The ID of the stack to access",
      "required": true
    },
    {
      "displayName": "Table",
      "name": "table",
      "type": "string",
      "default": "",
      "description": "Enter Table Name",
      "required": true
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "ID of the record to return",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "read",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 1000,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "View",
          "name": "view",
          "type": "string",
          "default": "",
          "placeholder": "All Stories",
          "description": "The name or ID of a view in the Stories table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Columns",
      "name": "columns",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the properties which should used as columns for the new rows",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "append"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "append",
      "name": "Append"
    },
    {
      "operation": "delete",
      "name": "Delete"
    },
    {
      "operation": "list",
      "name": "List"
    },
    {
      "operation": "read",
      "name": "Read"
    }
  ]


node_type: nodes-base.start
package_name: n8n-nodes-base
display_name: Start
description: Starts the workflow execution from this node
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-18 20:35:39
properties_schema:
  [
    {
      "displayName": "This node is where a manual workflow execution starts. To make one, go back to the canvas and click ‘execute workflow’",
      "name": "notice",
      "type": "notice",
      "default": ""
    }
  ]


node_type: nodes-base.stopAndError
package_name: n8n-nodes-base
display_name: Stop and Error
description: Throw an error in the workflow
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Stop And Error
  description: Documentation for the Stop And Error node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # Stop And Error

  Use the Stop And Error node to display custom error messages, cause executions to fail under certain conditions, and send custom error information to error workflows.

  ## Operations

  * Error Message
  * Error Object

  ## Node parameters

  Both operations include one node parameter, the **Error Type**. Use this parameter to select the type of error to throw. Choose between the two operations: **Error Message** and **Error Object**.

  The other parameters depend on which operation you select.

  ### Error Message parameters

  The Error Message Error Type adds one parameter, the **Error Message** field. Enter the message you'd like to throw.

  ### Error Object parameters

  The Error Object Error Type adds one parameter, the **Error Object**. Enter a JSON object that contains the error properties you'd like to throw.

  ## Templates and examples

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

  ## Related resources

  You can use the Stop And Error node with the [Error trigger](/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger.md) node.

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

properties_schema:
  [
    {
      "displayName": "Error Type",
      "name": "errorType",
      "type": "options",
      "default": "errorMessage",
      "description": "Type of error to throw",
      "options": [
        {
          "name": "Error Message",
          "value": "errorMessage"
        },
        {
          "name": "Error Object",
          "value": "errorObject"
        }
      ]
    },
    {
      "displayName": "Error Message",
      "name": "errorMessage",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "errorType": [
            "errorMessage"
          ]
        }
      }
    },
    {
      "displayName": "Error Object",
      "name": "errorObject",
      "type": "json",
      "default": "",
      "description": "Object containing error properties",
      "required": true,
      "displayOptions": {
        "show": {
          "errorType": [
            "errorObject"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    }
  ]


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

  # Storyblok node

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

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

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

  ## Operations

  ### Content API

  - **Story**
      - Get a story
      - Get all stories


  ### Management API

  - **Story**
      - Delete a story
      - Get a story
      - Get all stories
      - Publish a story
      - Unpublish a story

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Source",
      "name": "source",
      "type": "options",
      "default": "contentApi",
      "description": "Pick where your data comes from, Content or Management API",
      "options": [
        {
          "name": "Content API",
          "value": "contentApi"
        },
        {
          "name": "Management API",
          "value": "managementApi"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "story",
      "options": [
        {
          "name": "Story",
          "value": "story"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "contentApi"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "story",
      "options": [
        {
          "name": "Story",
          "value": "story"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a story",
          "action": "Get a story"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many stories",
          "action": "Get many stories"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "contentApi"
          ],
          "resource": [
            "story"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "string",
      "default": "",
      "description": "The ID or slug of the story to get",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "contentApi"
          ],
          "resource": [
            "story"
          ],
          "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": {
          "source": [
            "contentApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "source": [
            "contentApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Starts With",
          "name": "starts_with",
          "type": "string",
          "default": "",
          "description": "Filter by slug"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "contentApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a story",
          "action": "Delete a story"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a story",
          "action": "Get a story"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many stories",
          "action": "Get many stories"
        },
        {
          "name": "Publish",
          "value": "publish",
          "description": "Publish a story",
          "action": "Publish a story"
        },
        {
          "name": "Unpublish",
          "value": "unpublish",
          "description": "Unpublish a story",
          "action": "Unpublish a story"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Space Name or ID",
      "name": "space",
      "type": "options",
      "default": "",
      "description": "The name of the space. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "displayName": "Story ID",
      "name": "storyId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the story",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Space Name or ID",
      "name": "space",
      "type": "options",
      "default": "",
      "description": "The name of the space. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "displayName": "Story ID",
      "name": "storyId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the story",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Space Name or ID",
      "name": "space",
      "type": "options",
      "default": "",
      "description": "The name of the space. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Starts With",
          "name": "starts_with",
          "type": "string",
          "default": "",
          "description": "Filter by slug"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Space Name or ID",
      "name": "space",
      "type": "options",
      "default": "",
      "description": "The name of the space. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "publish"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "displayName": "Story ID",
      "name": "storyId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the story",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Release ID",
          "name": "releaseId",
          "type": "string",
          "default": "",
          "description": "Numeric ID of release"
        },
        {
          "displayName": "Language",
          "name": "language",
          "type": "string",
          "default": "",
          "description": "Language code to publish the story individually (must be enabled in the space settings)"
        }
      ],
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "Space Name or ID",
      "name": "space",
      "type": "options",
      "default": "",
      "description": "The name of the space. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "unpublish"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSpaces"
      }
    },
    {
      "displayName": "Story ID",
      "name": "storyId",
      "type": "string",
      "default": "",
      "description": "Numeric ID of the story",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ],
          "resource": [
            "story"
          ],
          "operation": [
            "unpublish"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a story"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many stories"
    }
  ]

credentials_required:
  [
    {
      "name": "storyblokContentApi",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "contentApi"
          ]
        }
      }
    },
    {
      "name": "storyblokManagementApi",
      "required": true,
      "displayOptions": {
        "show": {
          "source": [
            "managementApi"
          ]
        }
      }
    }
  ]


node_type: nodes-base.strapi
package_name: n8n-nodes-base
display_name: Strapi
description: Consume Strapi API
category: input
development_style: programmatic
version: 1
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Strapi node documentation
  description: Learn how to use the Strapi node in n8n. Follow technical documentation to integrate Strapi node into your workflows.
  contentType: [integration, reference]
  ---

  # Strapi node

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

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

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

  ## Operations

  * Entry
      * Create
      * Delete
      * Get
      * Get Many
      * Update

  ## Templates and examples

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

  ## Related resources

  Refer to [Strapi's documentation](https://docs.strapi.io/dev-docs/api/rest){: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",
      "default": "password",
      "options": [
        {
          "name": "Username & Password",
          "value": "password"
        },
        {
          "name": "API Token",
          "value": "token"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "entry",
      "options": [
        {
          "name": "Entry",
          "value": "entry"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an entry",
          "action": "Create an entry"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an entry",
          "action": "Delete an entry"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an entry",
          "action": "Get an entry"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many entries",
          "action": "Get many entries"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an entry",
          "action": "Update an entry"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "string",
      "default": "",
      "description": "Name of the content type",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Columns",
      "name": "columns",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the properties which should used as columns for the new rows",
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "string",
      "default": "",
      "description": "Name of the content type",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Entry ID",
      "name": "entryId",
      "type": "string",
      "default": "",
      "description": "The ID of the entry to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "string",
      "default": "",
      "description": "Name of the content type",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Entry ID",
      "name": "entryId",
      "type": "string",
      "default": "",
      "description": "The ID of the entry to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "string",
      "default": "",
      "description": "Name of the content type",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "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": [
            "entry"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Publication State",
          "name": "publicationState",
          "type": "options",
          "options": [
            {
              "name": "Live",
              "value": "live"
            },
            {
              "name": "Preview",
              "value": "preview"
            }
          ],
          "default": "",
          "description": "Only select entries matching the publication state provided"
        },
        {
          "displayName": "Sort Fields",
          "name": "sort",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Sort Field"
          },
          "default": "",
          "placeholder": "name:asc",
          "description": "Name of the fields to sort the data by. By default will be sorted ascendingly. To modify that behavior, you have to add the sort direction after the name of sort field preceded by a colon. For example: <code>name:asc</code>."
        },
        {
          "displayName": "Where (JSON)",
          "name": "where",
          "type": "string",
          "default": "",
          "description": "JSON query to filter the data. <a href=\"https://strapi.io/documentation/developer-docs/latest/developer-resources/content-api/content-api.html#filters\">More info</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Content Type",
      "name": "contentType",
      "type": "string",
      "default": "",
      "description": "Name of the content type",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Key",
      "name": "updateKey",
      "type": "string",
      "default": "id",
      "description": "Name of the property which decides which rows in the database should be updated. Normally that would be \"id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Columns",
      "name": "columns",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the properties which should used as columns for the new rows",
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an entry"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an entry"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an entry"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many entries"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an entry"
    }
  ]

credentials_required:
  [
    {
      "name": "strapiApi",
      "required": true,
      "testedBy": "strapiApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "password"
          ]
        }
      }
    },
    {
      "name": "strapiTokenApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "token"
          ]
        }
      }
    }
  ]


node_type: nodes-base.strava
package_name: n8n-nodes-base
display_name: Strava
description: Consume Strava API
category: input
development_style: programmatic
version: 1.1
credentials_required:
  [
  {
  "name": "stravaOAuth2Api",
  "required": true
  }
  ]

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Strava node documentation
  description: Learn how to use the Strava node in n8n. Follow technical documentation to integrate Strava node into your workflows.
  contentType: [integration, reference]
  ---

  # Strava node

  Use the Strava node to automate work in Strava, and integrate Strava with other applications. n8n has built-in support for a wide range of Strava features, including creating new activities, and getting activity information. 

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

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

  ## Operations

  * Activity
      * Create a new activity
      * Get an activity
      * Get all activities
      * Get all activity comments
      * Get all activity kudos
      * Get all activity laps
      * Get all activity zones
      * Update an activity

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "activity",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new activity",
          "action": "Create an activity"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an activity",
          "action": "Get an activity"
        },
        {
          "name": "Get Comments",
          "value": "getComments",
          "description": "Get all activity comments",
          "action": "Get all activity comments"
        },
        {
          "name": "Get Kudos",
          "value": "getKudos",
          "description": "Get all activity kudos",
          "action": "Get all activity kudos"
        },
        {
          "name": "Get Laps",
          "value": "getLaps",
          "description": "Get all activity laps",
          "action": "Get all activity laps"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many activities",
          "action": "Get many activities"
        },
        {
          "name": "Get Streams",
          "value": "getStreams",
          "description": "Get activity streams",
          "action": "Get all activity streams"
        },
        {
          "name": "Get Zones",
          "value": "getZones",
          "description": "Get all activity zones",
          "action": "Get all activity zones"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an activity",
          "action": "Update an activity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the activity",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "string",
      "default": "",
      "description": "Type of activity. For example - Run, Ride etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ],
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Sport Type",
      "name": "sport_type",
      "type": "options",
      "default": "Run",
      "description": "Type of sport",
      "options": [
        {
          "name": "Alpine Ski",
          "value": "AlpineSki"
        },
        {
          "name": "Backcountry Ski",
          "value": "BackcountrySki"
        },
        {
          "name": "Badminton",
          "value": "Badminton"
        },
        {
          "name": "Canoeing",
          "value": "Canoeing"
        },
        {
          "name": "Crossfit",
          "value": "Crossfit"
        },
        {
          "name": "EBike Ride",
          "value": "EBikeRide"
        },
        {
          "name": "Elliptical",
          "value": "Elliptical"
        },
        {
          "name": "EMountain Bike Ride",
          "value": "EMountainBikeRide"
        },
        {
          "name": "Golf",
          "value": "Golf"
        },
        {
          "name": "Gravel Ride",
          "value": "GravelRide"
        },
        {
          "name": "Handcycle",
          "value": "Handcycle"
        },
        {
          "name": "HIIT",
          "value": "HighIntensityIntervalTraining"
        },
        {
          "name": "Hike",
          "value": "Hike"
        },
        {
          "name": "Ice Skate",
          "value": "IceSkate"
        },
        {
          "name": "Inline Skate",
          "value": "InlineSkate"
        },
        {
          "name": "Kayaking",
          "value": "Kayaking"
        },
        {
          "name": "Kitesurf",
          "value": "Kitesurf"
        },
        {
          "name": "Mountain Bike Ride",
          "value": "MountainBikeRide"
        },
        {
          "name": "Nordic Ski",
          "value": "NordicSki"
        },
        {
          "name": "Pickleball",
          "value": "Pickleball"
        },
        {
          "name": "Pilates",
          "value": "Pilates"
        },
        {
          "name": "Racquetball",
          "value": "Racquetball"
        },
        {
          "name": "Ride",
          "value": "Ride"
        },
        {
          "name": "Rock Climbing",
          "value": "RockClimbing"
        },
        {
          "name": "Roller Ski",
          "value": "RollerSki"
        },
        {
          "name": "Rowing",
          "value": "Rowing"
        },
        {
          "name": "Run",
          "value": "Run"
        },
        {
          "name": "Sail",
          "value": "Sail"
        },
        {
          "name": "Skateboard",
          "value": "Skateboard"
        },
        {
          "name": "Snowboard",
          "value": "Snowboard"
        },
        {
          "name": "Snowshoe",
          "value": "Snowshoe"
        },
        {
          "name": "Soccer",
          "value": "Soccer"
        },
        {
          "name": "Squash",
          "value": "Squash"
        },
        {
          "name": "Stair Stepper",
          "value": "StairStepper"
        },
        {
          "name": "Stand Up Paddling",
          "value": "StandUpPaddling"
        },
        {
          "name": "Surfing",
          "value": "Surfing"
        },
        {
          "name": "Swim",
          "value": "Swim"
        },
        {
          "name": "Table Tennis",
          "value": "TableTennis"
        },
        {
          "name": "Tennis",
          "value": "Tennis"
        },
        {
          "name": "Trail Run",
          "value": "TrailRun"
        },
        {
          "name": "Velomobile",
          "value": "Velomobile"
        },
        {
          "name": "Virtual Ride",
          "value": "VirtualRide"
        },
        {
          "name": "Virtual Row",
          "value": "VirtualRow"
        },
        {
          "name": "Virtual Run",
          "value": "VirtualRun"
        },
        {
          "name": "Walk",
          "value": "Walk"
        },
        {
          "name": "Weight Training",
          "value": "WeightTraining"
        },
        {
          "name": "Wheelchair",
          "value": "Wheelchair"
        },
        {
          "name": "Windsurf",
          "value": "Windsurf"
        },
        {
          "name": "Workout",
          "value": "Workout"
        },
        {
          "name": "Yoga",
          "value": "Yoga"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Start Date",
      "name": "startDate",
      "type": "dateTime",
      "default": "",
      "description": "ISO 8601 formatted date time",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Elapsed Time (Seconds)",
      "name": "elapsedTime",
      "type": "number",
      "default": 0,
      "description": "In seconds",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Commute",
          "name": "commute",
          "type": "boolean",
          "default": false,
          "description": "Whether to mark as commute"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the activity"
        },
        {
          "displayName": "Distance",
          "name": "distance",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "In meters"
        },
        {
          "displayName": "Trainer",
          "name": "trainer",
          "type": "boolean",
          "default": false,
          "description": "Whether to mark as a trainer activity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "string",
      "default": "",
      "description": "ID or email of activity",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Commute",
          "name": "commute",
          "type": "boolean",
          "default": false,
          "description": "Whether to mark as commute"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the activity"
        },
        {
          "displayName": "Gear ID",
          "name": "gear_id",
          "type": "string",
          "default": "",
          "description": "Identifier for the gear associated with the activity. ‘none’ clears gear from activity."
        },
        {
          "displayName": "Mute Activity",
          "name": "hide_from_home",
          "type": "boolean",
          "default": false,
          "description": "Do not publish to Home or Club feeds"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The name of the activity"
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "default": "",
          "description": "Type of activity. For example - Run, Ride etc.",
          "displayOptions": {
            "show": {
              "@version": [
                1
              ]
            }
          }
        },
        {
          "displayName": "Sport Type",
          "name": "sport_type",
          "type": "options",
          "options": [
            {
              "name": "Alpine Ski",
              "value": "AlpineSki"
            },
            {
              "name": "Backcountry Ski",
              "value": "BackcountrySki"
            },
            {
              "name": "Badminton",
              "value": "Badminton"
            },
            {
              "name": "Canoeing",
              "value": "Canoeing"
            },
            {
              "name": "Crossfit",
              "value": "Crossfit"
            },
            {
              "name": "EBike Ride",
              "value": "EBikeRide"
            },
            {
              "name": "Elliptical",
              "value": "Elliptical"
            },
            {
              "name": "EMountain Bike Ride",
              "value": "EMountainBikeRide"
            },
            {
              "name": "Golf",
              "value": "Golf"
            },
            {
              "name": "Gravel Ride",
              "value": "GravelRide"
            },
            {
              "name": "Handcycle",
              "value": "Handcycle"
            },
            {
              "name": "HIIT",
              "value": "HighIntensityIntervalTraining"
            },
            {
              "name": "Hike",
              "value": "Hike"
            },
            {
              "name": "Ice Skate",
              "value": "IceSkate"
            },
            {
              "name": "Inline Skate",
              "value": "InlineSkate"
            },
            {
              "name": "Kayaking",
              "value": "Kayaking"
            },
            {
              "name": "Kitesurf",
              "value": "Kitesurf"
            },
            {
              "name": "Mountain Bike Ride",
              "value": "MountainBikeRide"
            },
            {
              "name": "Nordic Ski",
              "value": "NordicSki"
            },
            {
              "name": "Pickleball",
              "value": "Pickleball"
            },
            {
              "name": "Pilates",
              "value": "Pilates"
            },
            {
              "name": "Racquetball",
              "value": "Racquetball"
            },
            {
              "name": "Ride",
              "value": "Ride"
            },
            {
              "name": "Rock Climbing",
              "value": "RockClimbing"
            },
            {
              "name": "Roller Ski",
              "value": "RollerSki"
            },
            {
              "name": "Rowing",
              "value": "Rowing"
            },
            {
              "name": "Run",
              "value": "Run"
            },
            {
              "name": "Sail",
              "value": "Sail"
            },
            {
              "name": "Skateboard",
              "value": "Skateboard"
            },
            {
              "name": "Snowboard",
              "value": "Snowboard"
            },
            {
              "name": "Snowshoe",
              "value": "Snowshoe"
            },
            {
              "name": "Soccer",
              "value": "Soccer"
            },
            {
              "name": "Squash",
              "value": "Squash"
            },
            {
              "name": "Stair Stepper",
              "value": "StairStepper"
            },
            {
              "name": "Stand Up Paddling",
              "value": "StandUpPaddling"
            },
            {
              "name": "Surfing",
              "value": "Surfing"
            },
            {
              "name": "Swim",
              "value": "Swim"
            },
            {
              "name": "Table Tennis",
              "value": "TableTennis"
            },
            {
              "name": "Tennis",
              "value": "Tennis"
            },
            {
              "name": "Trail Run",
              "value": "TrailRun"
            },
            {
              "name": "Velomobile",
              "value": "Velomobile"
            },
            {
              "name": "Virtual Ride",
              "value": "VirtualRide"
            },
            {
              "name": "Virtual Row",
              "value": "VirtualRow"
            },
            {
              "name": "Virtual Run",
              "value": "VirtualRun"
            },
            {
              "name": "Walk",
              "value": "Walk"
            },
            {
              "name": "Weight Training",
              "value": "WeightTraining"
            },
            {
              "name": "Wheelchair",
              "value": "Wheelchair"
            },
            {
              "name": "Windsurf",
              "value": "Windsurf"
            },
            {
              "name": "Workout",
              "value": "Workout"
            },
            {
              "name": "Yoga",
              "value": "Yoga"
            }
          ],
          "default": "Run",
          "description": "Type of sport",
          "displayOptions": {
            "hide": {
              "@version": [
                1
              ]
            }
          }
        },
        {
          "displayName": "Trainer",
          "name": "trainer",
          "type": "boolean",
          "default": false,
          "description": "Whether to mark as a trainer activity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "string",
      "default": "",
      "description": "ID or email of activity",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "string",
      "default": "",
      "description": "ID or email of activity",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getComments",
            "getLaps",
            "getKudos",
            "getZones",
            "getStreams"
          ]
        }
      }
    },
    {
      "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": [
            "getComments",
            "getLaps",
            "getKudos",
            "getZones"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getComments",
            "getLaps",
            "getKudos",
            "getZones"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Keys",
      "name": "keys",
      "type": "multiOptions",
      "default": [],
      "description": "Desired stream types to return",
      "options": [
        {
          "name": "Altitude",
          "value": "altitude"
        },
        {
          "name": "Cadence",
          "value": "cadence"
        },
        {
          "name": "Distance",
          "value": "distance"
        },
        {
          "name": "Gradient",
          "value": "grade_smooth"
        },
        {
          "name": "Heartrate",
          "value": "heartrate"
        },
        {
          "name": "Latitude / Longitude",
          "value": "latlng"
        },
        {
          "name": "Moving",
          "value": "moving"
        },
        {
          "name": "Temperature",
          "value": "temp"
        },
        {
          "name": "Time",
          "value": "time"
        },
        {
          "name": "Velocity",
          "value": "velocity_smooth"
        },
        {
          "name": "Watts",
          "value": "watts"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getStreams"
          ]
        }
      }
    },
    {
      "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",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an activity"
    },
    {
      "operation": "getComments",
      "name": "Get Comments",
      "description": "Get all activity comments"
    },
    {
      "operation": "getKudos",
      "name": "Get Kudos",
      "description": "Get all activity kudos"
    },
    {
      "operation": "getLaps",
      "name": "Get Laps",
      "description": "Get all activity laps"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many activities"
    },
    {
      "operation": "getStreams",
      "name": "Get Streams",
      "description": "Get activity streams"
    },
    {
      "operation": "getZones",
      "name": "Get Zones",
      "description": "Get all activity zones"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity"
    }
  ]


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

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Strava Trigger node documentation
  description: Learn how to use the Strava Trigger node in n8n. Follow technical documentation to integrate Strava Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Strava Trigger node

  [Strava](https://www.strava.com/){:target=_blank .external-link} is an internet service for tracking human exercise which incorporates social network features.

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

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

  ## Events

  - **\[All\]**
      - \[All\]
      - Created
      - Deleted
      - Updated
  - **Activity**
      - \[All\]
      - Created
      - Deleted
      - Updated
  - **Athlete**
      - \[All\]
      - Created
      - Deleted
      - Updated

properties_schema:
  [
    {
      "displayName": "Object",
      "name": "object",
      "type": "options",
      "default": "*",
      "options": [
        {
          "name": "[All]",
          "value": "*"
        },
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Athlete",
          "value": "athlete"
        }
      ]
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "*",
      "options": [
        {
          "name": "[All]",
          "value": "*"
        },
        {
          "name": "Created",
          "value": "create"
        },
        {
          "name": "Deleted",
          "value": "delete"
        },
        {
          "name": "Updated",
          "value": "update"
        }
      ]
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the webhook-data only contain the Object ID. If this option gets activated, it will resolve the data automatically."
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delete If Exist",
          "name": "deleteIfExist",
          "type": "boolean",
          "default": false,
          "description": "Strava allows just one subscription at all times. If you want to delete the current subscription to make room for a new subscription with the current parameters, set this parameter to true. Keep in mind this is a destructive operation."
        }
      ]
    }
  ]


node_type: nodes-base.stripe
package_name: n8n-nodes-base
display_name: Stripe
description: Consume the Stripe API
category: transform
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "get",
  "name": "Get",
  "description": "Get a balance"
  }
  ]

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

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Stripe node documentation
  description: Learn how to use the Stripe node in n8n. Follow technical documentation to integrate Stripe node into your workflows.
  contentType: [integration, reference]
  ---

  # Stripe node

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

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

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

  ## Operations

  * Balance
      * Get a balance
  * Charge
      * Create a charge
      * Get a charge
      * Get all charges
      * Update a charge
  * Coupon
      * Create a coupon
      * Get all coupons
  * Customer
      * Create a customer
      * Delete a customer
      * Get a customer
      * Get all customers
      * Update a customer
  * Customer Card
      * Add a customer card
      * Get a customer card
      * Remove a customer card
  * Source
      * Create a source
      * Delete a source
      * Get a source
  * Token
      * Create a token

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "balance",
      "options": [
        {
          "name": "Balance",
          "value": "balance"
        },
        {
          "name": "Charge",
          "value": "charge"
        },
        {
          "name": "Coupon",
          "value": "coupon"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Customer Card",
          "value": "customerCard"
        },
        {
          "name": "Source",
          "value": "source"
        },
        {
          "name": "Token",
          "value": "token"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a balance",
          "action": "Get a balance"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "balance"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a customer card",
          "action": "Add a customer card"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a customer card",
          "action": "Get a customer card"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a customer card",
          "action": "Remove a customer card"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to be associated with this card",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Card Token",
      "name": "token",
      "type": "string",
      "default": "",
      "description": "Token representing sensitive card information",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer whose card to remove",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Card ID",
      "name": "cardId",
      "type": "string",
      "default": "",
      "description": "ID of the card to remove",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer whose card to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Source ID",
      "name": "sourceId",
      "type": "string",
      "default": "",
      "description": "ID of the source to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customerCard"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a charge",
          "action": "Create a charge"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a charge",
          "action": "Get a charge"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many charges",
          "action": "Get many charges"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a charge",
          "action": "Update a charge"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to be associated with this charge",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 0,
      "description": "Amount in cents to be collected for this charge, e.g. enter <code>100</code> for $1.00",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0,
        "maxValue": 99999999
      }
    },
    {
      "displayName": "Currency Name or ID",
      "name": "currency",
      "type": "options",
      "default": "",
      "description": "Three-letter ISO currency code, e.g. <code>USD</code> or <code>EUR</code>. It must be a <a href=\"https://stripe.com/docs/currencies\">Stripe-supported currency</a>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCurrencies"
      }
    },
    {
      "displayName": "Source ID",
      "name": "source",
      "type": "string",
      "default": "",
      "description": "ID of the customer's payment source to be charged",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Arbitrary text to describe the charge to create"
        },
        {
          "displayName": "Metadata",
          "name": "metadata",
          "type": "fixedCollection",
          "default": [],
          "placeholder": "Add Metadata Item",
          "description": "Set of key-value pairs to attach to the charge to create",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Metadata Properties",
              "name": "metadataProperties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Receipt Email",
          "name": "receipt_email",
          "type": "string",
          "default": "",
          "description": "Email address to which the receipt for this charge will be sent"
        },
        {
          "displayName": "Shipping",
          "name": "shipping",
          "type": "fixedCollection",
          "description": "Shipping information for the charge",
          "placeholder": "Add Field",
          "typeOptions": {
            "multipleValues": true
          },
          "default": [],
          "options": [
            {
              "displayName": "Shipping Properties",
              "name": "shippingProperties",
              "values": [
                {
                  "displayName": "Recipient Name",
                  "name": "name",
                  "type": "string",
                  "description": "Name of the person who will receive the shipment",
                  "default": ""
                },
                {
                  "displayName": "Address",
                  "name": "address",
                  "type": "fixedCollection",
                  "default": {},
                  "placeholder": "Add Field",
                  "options": [
                    {
                      "displayName": "Details",
                      "name": "details",
                      "values": [
                        {
                          "displayName": "Line 1",
                          "name": "line1",
                          "description": "Address line 1 (e.g. street, PO Box, or company name)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Line 2",
                          "name": "line2",
                          "description": "Address line 2 (e.g. apartment, suite, unit, or building)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "City",
                          "name": "city",
                          "description": "City, district, suburb, town, or village",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "State",
                          "name": "state",
                          "description": "State, county, province, or region",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Country",
                          "name": "country",
                          "description": "Two-letter country code (<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a>)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Postal Code",
                          "name": "postal_code",
                          "description": "ZIP or postal code",
                          "type": "string",
                          "default": ""
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Charge ID",
      "name": "chargeId",
      "type": "string",
      "default": "",
      "description": "ID of the charge to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "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": [
            "charge"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Charge ID",
      "name": "chargeId",
      "type": "string",
      "default": "",
      "description": "ID of the charge to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Arbitrary text to describe the charge to update"
        },
        {
          "displayName": "Metadata",
          "name": "metadata",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Metadata Item",
          "description": "Set of key-value pairs to attach to the charge to update",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Metadata Properties",
              "name": "metadataProperties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Receipt Email",
          "name": "receipt_email",
          "type": "string",
          "default": "",
          "description": "The email address to which the receipt for this charge will be sent"
        },
        {
          "displayName": "Shipping",
          "name": "shipping",
          "type": "fixedCollection",
          "default": {},
          "description": "Shipping information for the charge",
          "placeholder": "Add Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Shipping Properties",
              "name": "shippingProperties",
              "default": {},
              "values": [
                {
                  "displayName": "Recipient Name",
                  "name": "name",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Recipient Address",
                  "name": "address",
                  "type": "fixedCollection",
                  "default": {},
                  "placeholder": "Add Address Details",
                  "options": [
                    {
                      "displayName": "Details",
                      "name": "details",
                      "values": [
                        {
                          "displayName": "Line 1",
                          "name": "line1",
                          "description": "Address line 1 (e.g. street, PO Box, or company name)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Line 2",
                          "name": "line2",
                          "description": "Address line 2 (e.g. apartment, suite, unit, or building)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "City",
                          "name": "city",
                          "description": "City, district, suburb, town, or village",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "State",
                          "name": "state",
                          "description": "State, county, province, or region",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Country",
                          "name": "country",
                          "description": "Two-letter country code (<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a>)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Postal Code",
                          "name": "postal_code",
                          "description": "ZIP or postal code",
                          "type": "string",
                          "default": ""
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Apply",
      "name": "duration",
      "type": "options",
      "default": "once",
      "description": "How long the discount will be in effect",
      "options": [
        {
          "name": "Forever",
          "value": "forever"
        },
        {
          "name": "Once",
          "value": "once"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Discount Type",
      "name": "type",
      "type": "options",
      "default": "percent",
      "description": "Whether the coupon discount is a percentage or a fixed amount",
      "options": [
        {
          "name": "Fixed Amount (in Cents)",
          "value": "fixedAmount"
        },
        {
          "name": "Percent",
          "value": "percent"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Amount Off",
      "name": "amountOff",
      "type": "number",
      "default": 0,
      "description": "Amount in cents to subtract from an invoice total, e.g. enter <code>100</code> for $1.00",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "fixedAmount"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0,
        "maxValue": 99999999
      }
    },
    {
      "displayName": "Currency Name or ID",
      "name": "currency",
      "type": "options",
      "default": "",
      "description": "Three-letter ISO currency code, e.g. <code>USD</code> or <code>EUR</code>. It must be a <a href=\"https://stripe.com/docs/currencies\">Stripe-supported currency</a>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "fixedAmount"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCurrencies"
      }
    },
    {
      "displayName": "Percent Off",
      "name": "percentOff",
      "type": "number",
      "default": 1,
      "description": "Percentage to apply with the coupon",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "percent"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "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": [
            "coupon"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a customer",
          "action": "Create a customer"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a customer",
          "action": "Delete a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a customer",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many customers",
          "action": "Get many customers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a customer",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Full name or business name of the customer to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "type": "fixedCollection",
          "description": "Address of the customer to create",
          "placeholder": "Add Field",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "line1",
                  "description": "Address line 1 (e.g. street, PO Box, or company name)",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "line2",
                  "description": "Address line 2 (e.g. apartment, suite, unit, or building)",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "description": "City, district, suburb, town, or village",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "description": "State, county, province, or region",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "description": "Two-letter country code (<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a>)",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "description": "ZIP or postal code",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Arbitrary text to describe the customer to create"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email of the customer to create"
        },
        {
          "displayName": "Metadata",
          "name": "metadata",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Metadata Item",
          "description": "Set of key-value pairs to attach to the customer to create",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Metadata Properties",
              "name": "metadataProperties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "Telephone number of the customer to create"
        },
        {
          "displayName": "Shipping",
          "name": "shipping",
          "type": "fixedCollection",
          "default": {},
          "description": "Shipping information for the customer",
          "typeOptions": {
            "multipleValues": true
          },
          "placeholder": "Add Field",
          "options": [
            {
              "displayName": "Shipping Properties",
              "name": "shippingProperties",
              "values": [
                {
                  "displayName": "Recipient Name",
                  "name": "name",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Recipient Address",
                  "name": "address",
                  "type": "fixedCollection",
                  "default": {},
                  "placeholder": "Add Address Details",
                  "options": [
                    {
                      "displayName": "Details",
                      "name": "details",
                      "values": [
                        {
                          "displayName": "Line 1",
                          "name": "line1",
                          "description": "Address line 1 (e.g. street, PO Box, or company name)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Line 2",
                          "name": "line2",
                          "description": "Address line 2 (e.g. apartment, suite, unit, or building)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "City",
                          "name": "city",
                          "description": "City, district, suburb, town, or village",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "State",
                          "name": "state",
                          "description": "State, county, province, or region",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Country",
                          "name": "country",
                          "description": "Two-letter country code (<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a>)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Postal Code",
                          "name": "postal_code",
                          "description": "ZIP or postal code",
                          "type": "string",
                          "default": ""
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Recipient Phone",
                  "name": "phone",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Customer's email to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "type": "fixedCollection",
          "description": "Address of the customer to update",
          "placeholder": "Add Field",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "line1",
                  "description": "Address line 1 (e.g. street, PO Box, or company name)",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "line2",
                  "description": "Address line 2 (e.g. apartment, suite, unit, or building)",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "description": "City, district, suburb, town, or village",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "description": "State, county, province, or region",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "description": "Two-letter country code (<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a>)",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "description": "ZIP or postal code",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Arbitrary text to describe the customer to create"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email of the customer to create"
        },
        {
          "displayName": "Metadata",
          "name": "metadata",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Metadata Item",
          "description": "Set of key-value pairs to attach to the customer to create",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Metadata Properties",
              "name": "metadataProperties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Full name or business name of the customer to create"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "Telephone number of this customer"
        },
        {
          "displayName": "Shipping",
          "name": "shipping",
          "type": "fixedCollection",
          "description": "Shipping information for the customer",
          "placeholder": "Add Field",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Shipping Properties",
              "name": "shippingProperties",
              "values": [
                {
                  "displayName": "Recipient Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the person who will receive the shipment"
                },
                {
                  "displayName": "Recipient Address",
                  "name": "address",
                  "type": "fixedCollection",
                  "default": {},
                  "placeholder": "Add Address Details",
                  "options": [
                    {
                      "displayName": "Details",
                      "name": "details",
                      "values": [
                        {
                          "displayName": "Line 1",
                          "name": "line1",
                          "description": "Address line 1 (e.g. street, PO Box, or company name)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Line 2",
                          "name": "line2",
                          "description": "Address line 2 (e.g. apartment, suite, unit, or building)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "City",
                          "name": "city",
                          "description": "City, district, suburb, town, or village",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "State",
                          "name": "state",
                          "description": "State, county, province, or region",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Country",
                          "name": "country",
                          "description": "Two-letter country code (<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a>)",
                          "type": "string",
                          "default": ""
                        },
                        {
                          "displayName": "Postal Code",
                          "name": "postal_code",
                          "description": "ZIP or postal code",
                          "type": "string",
                          "default": ""
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Recipient Phone",
                  "name": "phone",
                  "type": "string",
                  "default": "",
                  "description": "Phone number of the person who will receive the shipment"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a source",
          "action": "Create a source"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a source",
          "action": "Delete a source"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a source",
          "action": "Get a source"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer to attach the source to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "wechat",
      "description": "Type of source (payment instrument) to create",
      "options": [
        {
          "name": "WeChat",
          "value": "wechat"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 0,
      "description": "Amount in cents to be collected for this charge, e.g. enter <code>100</code> for $1.00",
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0,
        "maxValue": 99999999
      }
    },
    {
      "displayName": "Currency Name or ID",
      "name": "currency",
      "type": "options",
      "default": "",
      "description": "Three-letter ISO currency code, e.g. <code>USD</code> or <code>EUR</code>. It must be a <a href=\"https://stripe.com/docs/currencies\">Stripe-supported currency</a>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCurrencies"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Metadata",
          "name": "metadata",
          "type": "fixedCollection",
          "placeholder": "Add Metadata Item",
          "description": "Set of key-value pairs to attach to the source to create",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Metadata Properties",
              "name": "metadataProperties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Statement Descriptor",
          "name": "statement_descriptor",
          "type": "string",
          "default": "",
          "description": "Arbitrary text to display on the customer's statement"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "ID of the customer whose source to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Source ID",
      "name": "sourceId",
      "type": "string",
      "default": "",
      "description": "ID of the source to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Source ID",
      "name": "sourceId",
      "type": "string",
      "default": "",
      "description": "ID of the source to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "source"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a token",
          "action": "Create a token"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "token"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "cardToken",
      "description": "Type of token to create",
      "options": [
        {
          "name": "Card Token",
          "value": "cardToken"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "token"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Card Number",
      "name": "number",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "token"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "cardToken"
          ]
        }
      }
    },
    {
      "displayName": "CVC",
      "name": "cvc",
      "type": "string",
      "default": "",
      "description": "Security code printed on the back of the card",
      "displayOptions": {
        "show": {
          "resource": [
            "token"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "cardToken"
          ]
        }
      }
    },
    {
      "displayName": "Expiration Month",
      "name": "expirationMonth",
      "type": "string",
      "default": "",
      "description": "Number of the month when the card will expire",
      "displayOptions": {
        "show": {
          "resource": [
            "token"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "cardToken"
          ]
        }
      }
    },
    {
      "displayName": "Expiration Year",
      "name": "expirationYear",
      "type": "string",
      "default": "",
      "description": "Year when the card will expire",
      "displayOptions": {
        "show": {
          "resource": [
            "token"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "cardToken"
          ]
        }
      }
    }
  ]


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

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

  # Stripe Trigger node

  [Stripe](https://stripe.com/){:target=_blank .external-link} is a suite of payment APIs that powers commerce for online businesses.

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

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

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The event to listen to",
      "options": [
        {
          "name": "*",
          "value": "*",
          "description": "Any time any event is triggered (Wildcard Event)"
        },
        {
          "name": "Account Updated",
          "value": "account.updated",
          "description": "Occurs whenever an account status or property has changed"
        },
        {
          "name": "Account Application.authorized",
          "value": "account.application.authorized",
          "description": "Occurs whenever a user authorizes an application. Sent to the related application only."
        },
        {
          "name": "Account Application.deauthorized",
          "value": "account.application.deauthorized",
          "description": "Occurs whenever a user deauthorizes an application. Sent to the related application only."
        },
        {
          "name": "Account External_account.created",
          "value": "account.external_account.created",
          "description": "Occurs whenever an external account is created."
        },
        {
          "name": "Account External_account.deleted",
          "value": "account.external_account.deleted",
          "description": "Occurs whenever an external account is deleted."
        },
        {
          "name": "Account External_account.updated",
          "value": "account.external_account.updated",
          "description": "Occurs whenever an external account is updated."
        },
        {
          "name": "Application Fee.created",
          "value": "application_fee.created",
          "description": "Occurs whenever an application fee is created on a charge."
        },
        {
          "name": "Application Fee.refunded",
          "value": "application_fee.refunded",
          "description": "Occurs whenever an application fee is refunded, whether from refunding a charge or from refunding the application fee directly. This includes partial refunds."
        },
        {
          "name": "Application Fee.refund.updated",
          "value": "application_fee.refund.updated",
          "description": "Occurs whenever an application fee refund is updated."
        },
        {
          "name": "Balance Available",
          "value": "balance.available",
          "description": "Occurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis."
        },
        {
          "name": "Capability Updated",
          "value": "capability.updated",
          "description": "Occurs whenever a capability has new requirements or a new status."
        },
        {
          "name": "Charge Captured",
          "value": "charge.captured",
          "description": "Occurs whenever a previously uncaptured charge is captured."
        },
        {
          "name": "Charge Expired",
          "value": "charge.expired",
          "description": "Occurs whenever an uncaptured charge expires."
        },
        {
          "name": "Charge Failed",
          "value": "charge.failed",
          "description": "Occurs whenever a failed charge attempt occurs."
        },
        {
          "name": "Charge Pending",
          "value": "charge.pending",
          "description": "Occurs whenever a pending charge is created."
        },
        {
          "name": "Charge Refunded",
          "value": "charge.refunded",
          "description": "Occurs whenever a charge is refunded, including partial refunds."
        },
        {
          "name": "Charge Succeeded",
          "value": "charge.succeeded",
          "description": "Occurs whenever a new charge is created and is successful."
        },
        {
          "name": "Charge Updated",
          "value": "charge.updated",
          "description": "Occurs whenever a charge description or metadata is updated."
        },
        {
          "name": "Charge Dispute.closed",
          "value": "charge.dispute.closed",
          "description": "Occurs when a dispute is closed and the dispute status changes to lost, warning_closed, or won."
        },
        {
          "name": "Charge Dispute.created",
          "value": "charge.dispute.created",
          "description": "Occurs whenever a customer disputes a charge with their bank."
        },
        {
          "name": "Charge Dispute.funds_reinstated",
          "value": "charge.dispute.funds_reinstated",
          "description": "Occurs when funds are reinstated to your account after a dispute is closed. This includes partially refunded payments."
        },
        {
          "name": "Charge Dispute.funds_withdrawn",
          "value": "charge.dispute.funds_withdrawn",
          "description": "Occurs when funds are removed from your account due to a dispute."
        },
        {
          "name": "Charge Dispute.updated",
          "value": "charge.dispute.updated",
          "description": "Occurs when the dispute is updated (usually with evidence)."
        },
        {
          "name": "Charge Refund.updated",
          "value": "charge.refund.updated",
          "description": "Occurs whenever a refund is updated, on selected payment methods."
        },
        {
          "name": "Checkout Session.completed",
          "value": "checkout.session.completed",
          "description": "Occurs when a Checkout Session has been successfully completed."
        },
        {
          "name": "Coupon Created",
          "value": "coupon.created",
          "description": "Occurs whenever a coupon is created."
        },
        {
          "name": "Coupon Deleted",
          "value": "coupon.deleted",
          "description": "Occurs whenever a coupon is deleted."
        },
        {
          "name": "Coupon Updated",
          "value": "coupon.updated",
          "description": "Occurs whenever a coupon is updated."
        },
        {
          "name": "Credit Note.created",
          "value": "credit_note.created",
          "description": "Occurs whenever a credit note is created."
        },
        {
          "name": "Credit Note.updated",
          "value": "credit_note.updated",
          "description": "Occurs whenever a credit note is updated."
        },
        {
          "name": "Credit Note.voided",
          "value": "credit_note.voided",
          "description": "Occurs whenever a credit note is voided."
        },
        {
          "name": "Customer Created",
          "value": "customer.created",
          "description": "Occurs whenever a new customer is created."
        },
        {
          "name": "Customer Deleted",
          "value": "customer.deleted",
          "description": "Occurs whenever a customer is deleted."
        },
        {
          "name": "Customer Updated",
          "value": "customer.updated",
          "description": "Occurs whenever any property of a customer changes."
        },
        {
          "name": "Customer Discount.created",
          "value": "customer.discount.created",
          "description": "Occurs whenever a coupon is attached to a customer."
        },
        {
          "name": "Customer Discount.deleted",
          "value": "customer.discount.deleted",
          "description": "Occurs whenever a coupon is removed from a customer."
        },
        {
          "name": "Customer Discount.updated",
          "value": "customer.discount.updated",
          "description": "Occurs whenever a customer is switched from one coupon to another."
        },
        {
          "name": "Customer Source.created",
          "value": "customer.source.created",
          "description": "Occurs whenever a new source is created for a customer."
        },
        {
          "name": "Customer Source.deleted",
          "value": "customer.source.deleted",
          "description": "Occurs whenever a source is removed from a customer."
        },
        {
          "name": "Customer Source.expiring",
          "value": "customer.source.expiring",
          "description": "Occurs whenever a card or source will expire at the end of the month."
        },
        {
          "name": "Customer Source.updated",
          "value": "customer.source.updated",
          "description": "Occurs whenever a source's details are changed."
        },
        {
          "name": "Customer Subscription.created",
          "value": "customer.subscription.created",
          "description": "Occurs whenever a customer is signed up for a new plan."
        },
        {
          "name": "Customer Subscription.deleted",
          "value": "customer.subscription.deleted",
          "description": "Occurs whenever a customer's subscription ends."
        },
        {
          "name": "Customer Subscription.trial_will_end",
          "value": "customer.subscription.trial_will_end",
          "description": "Occurs three days before a subscription's trial period is scheduled to end, or when a trial is ended immediately (using trial_end=now)."
        },
        {
          "name": "Customer Subscription.updated",
          "value": "customer.subscription.updated",
          "description": "Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active)."
        },
        {
          "name": "Customer Tax_id.created",
          "value": "customer.tax_id.created",
          "description": "Occurs whenever a tax ID is created for a customer."
        },
        {
          "name": "Customer Tax_id.deleted",
          "value": "customer.tax_id.deleted",
          "description": "Occurs whenever a tax ID is deleted from a customer."
        },
        {
          "name": "Customer Tax_id.updated",
          "value": "customer.tax_id.updated",
          "description": "Occurs whenever a customer's tax ID is updated."
        },
        {
          "name": "File Created",
          "value": "file.created",
          "description": "Occurs whenever a new Stripe-generated file is available for your account."
        },
        {
          "name": "Invoice Created",
          "value": "invoice.created",
          "description": "Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see Using Webhooks with Subscriptions."
        },
        {
          "name": "Invoice Deleted",
          "value": "invoice.deleted",
          "description": "Occurs whenever a draft invoice is deleted."
        },
        {
          "name": "Invoice Finalized",
          "value": "invoice.finalized",
          "description": "Occurs whenever a draft invoice is finalized and updated to be an open invoice."
        },
        {
          "name": "Invoice Marked_uncollectible",
          "value": "invoice.marked_uncollectible",
          "description": "Occurs whenever an invoice is marked uncollectible."
        },
        {
          "name": "Invoice Payment_action_required",
          "value": "invoice.payment_action_required",
          "description": "Occurs whenever an invoice payment attempt requires further user action to complete."
        },
        {
          "name": "Invoice Payment_failed",
          "value": "invoice.payment_failed",
          "description": "Occurs whenever an invoice payment attempt fails, due either to a declined payment or to the lack of a stored payment method."
        },
        {
          "name": "Invoice Payment_succeeded",
          "value": "invoice.payment_succeeded",
          "description": "Occurs whenever an invoice payment attempt succeeds."
        },
        {
          "name": "Invoice Sent",
          "value": "invoice.sent",
          "description": "Occurs whenever an invoice email is sent out."
        },
        {
          "name": "Invoice Upcoming",
          "value": "invoice.upcoming",
          "description": "Occurs X number of days before a subscription is scheduled to create an invoice that is automatically charged—where X is determined by your subscriptions settings. Note: The received Invoice object will not have an invoice ID."
        },
        {
          "name": "Invoice Updated",
          "value": "invoice.updated",
          "description": "Occurs whenever an invoice changes (e.g., the invoice amount)."
        },
        {
          "name": "Invoice Voided",
          "value": "invoice.voided",
          "description": "Occurs whenever an invoice is voided."
        },
        {
          "name": "Invoiceitem Created",
          "value": "invoiceitem.created",
          "description": "Occurs whenever an invoice item is created."
        },
        {
          "name": "Invoiceitem Deleted",
          "value": "invoiceitem.deleted",
          "description": "Occurs whenever an invoice item is deleted."
        },
        {
          "name": "Invoiceitem Updated",
          "value": "invoiceitem.updated",
          "description": "Occurs whenever an invoice item is updated."
        },
        {
          "name": "Issuing Authorization.created",
          "value": "issuing_authorization.created",
          "description": "Occurs whenever an authorization is created."
        },
        {
          "name": "Issuing Authorization.request",
          "value": "issuing_authorization.request",
          "description": "Represents a synchronous request for authorization, see Using your integration to handle authorization requests."
        },
        {
          "name": "Issuing Authorization.updated",
          "value": "issuing_authorization.updated",
          "description": "Occurs whenever an authorization is updated."
        },
        {
          "name": "Issuing Card.created",
          "value": "issuing_card.created",
          "description": "Occurs whenever a card is created."
        },
        {
          "name": "Issuing Card.updated",
          "value": "issuing_card.updated",
          "description": "Occurs whenever a card is updated."
        },
        {
          "name": "Issuing Cardholder.created",
          "value": "issuing_cardholder.created",
          "description": "Occurs whenever a cardholder is created."
        },
        {
          "name": "Issuing Cardholder.updated",
          "value": "issuing_cardholder.updated",
          "description": "Occurs whenever a cardholder is updated."
        },
        {
          "name": "Issuing Dispute.created",
          "value": "issuing_dispute.created",
          "description": "Occurs whenever a dispute is created."
        },
        {
          "name": "Issuing Dispute.updated",
          "value": "issuing_dispute.updated",
          "description": "Occurs whenever a dispute is updated."
        },
        {
          "name": "Issuing Settlement.created",
          "value": "issuing_settlement.created",
          "description": "Occurs whenever an issuing settlement is created."
        },
        {
          "name": "Issuing Settlement.updated",
          "value": "issuing_settlement.updated",
          "description": "Occurs whenever an issuing settlement is updated."
        },
        {
          "name": "Issuing Transaction.created",
          "value": "issuing_transaction.created",
          "description": "Occurs whenever an issuing transaction is created."
        },
        {
          "name": "Issuing Transaction.updated",
          "value": "issuing_transaction.updated",
          "description": "Occurs whenever an issuing transaction is updated."
        },
        {
          "name": "Order Created",
          "value": "order.created",
          "description": "Occurs whenever an order is created."
        },
        {
          "name": "Order Payment_failed",
          "value": "order.payment_failed",
          "description": "Occurs whenever an order payment attempt fails."
        },
        {
          "name": "Order Payment_succeeded",
          "value": "order.payment_succeeded",
          "description": "Occurs whenever an order payment attempt succeeds."
        },
        {
          "name": "Order Updated",
          "value": "order.updated",
          "description": "Occurs whenever an order is updated."
        },
        {
          "name": "Order Return.created",
          "value": "order_return.created",
          "description": "Occurs whenever an order return is created."
        },
        {
          "name": "Payment Intent.amount_capturable_updated",
          "value": "payment_intent.amount_capturable_updated",
          "description": "Occurs when a PaymentIntent has funds to be captured. Check the amount_capturable property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an amount_to_capture value up to the specified amount. Learn more about capturing PaymentIntents."
        },
        {
          "name": "Payment Intent.canceled",
          "value": "payment_intent.canceled",
          "description": "Occurs when a PaymentIntent is canceled."
        },
        {
          "name": "Payment Intent.created",
          "value": "payment_intent.created",
          "description": "Occurs when a new PaymentIntent is created."
        },
        {
          "name": "Payment Intent.payment_failed",
          "value": "payment_intent.payment_failed",
          "description": "Occurs when a PaymentIntent has failed the attempt to create a source or a payment."
        },
        {
          "name": "Payment Intent.succeeded",
          "value": "payment_intent.succeeded",
          "description": "Occurs when a PaymentIntent has been successfully fulfilled."
        },
        {
          "name": "Payment Intent.requires_action",
          "value": "payment_intent.requires_action",
          "description": "Occurs when a PaymentIntent requires an action."
        },
        {
          "name": "Payment Method.attached",
          "value": "payment_method.attached",
          "description": "Occurs whenever a new payment method is attached to a customer."
        },
        {
          "name": "Payment Method.card_automatically_updated",
          "value": "payment_method.card_automatically_updated",
          "description": "Occurs whenever a card payment method's details are automatically updated by the network."
        },
        {
          "name": "Payment Method.detached",
          "value": "payment_method.detached",
          "description": "Occurs whenever a payment method is detached from a customer."
        },
        {
          "name": "Payment Method.updated",
          "value": "payment_method.updated",
          "description": "Occurs whenever a payment method is updated via the PaymentMethod update API."
        },
        {
          "name": "Payout Canceled",
          "value": "payout.canceled",
          "description": "Occurs whenever a payout is canceled."
        },
        {
          "name": "Payout Created",
          "value": "payout.created",
          "description": "Occurs whenever a payout is created."
        },
        {
          "name": "Payout Failed",
          "value": "payout.failed",
          "description": "Occurs whenever a payout attempt fails."
        },
        {
          "name": "Payout Paid",
          "value": "payout.paid",
          "description": "Occurs whenever a payout is expected to be available in the destination account. If the payout fails, a payout.failed notification is also sent, at a later time."
        },
        {
          "name": "Payout Updated",
          "value": "payout.updated",
          "description": "Occurs whenever a payout is updated."
        },
        {
          "name": "Person Created",
          "value": "person.created",
          "description": "Occurs whenever a person associated with an account is created."
        },
        {
          "name": "Person Deleted",
          "value": "person.deleted",
          "description": "Occurs whenever a person associated with an account is deleted."
        },
        {
          "name": "Person Updated",
          "value": "person.updated",
          "description": "Occurs whenever a person associated with an account is updated."
        },
        {
          "name": "Plan Created",
          "value": "plan.created",
          "description": "Occurs whenever a plan is created."
        },
        {
          "name": "Plan Deleted",
          "value": "plan.deleted",
          "description": "Occurs whenever a plan is deleted."
        },
        {
          "name": "Plan Updated",
          "value": "plan.updated",
          "description": "Occurs whenever a plan is updated."
        },
        {
          "name": "Product Created",
          "value": "product.created",
          "description": "Occurs whenever a product is created."
        },
        {
          "name": "Product Deleted",
          "value": "product.deleted",
          "description": "Occurs whenever a product is deleted."
        },
        {
          "name": "Product Updated",
          "value": "product.updated",
          "description": "Occurs whenever a product is updated."
        },
        {
          "name": "Radar Early_fraud_warning.created",
          "value": "radar.early_fraud_warning.created",
          "description": "Occurs whenever an early fraud warning is created."
        },
        {
          "name": "Radar Early_fraud_warning.updated",
          "value": "radar.early_fraud_warning.updated",
          "description": "Occurs whenever an early fraud warning is updated."
        },
        {
          "name": "Recipient Created",
          "value": "recipient.created",
          "description": "Occurs whenever a recipient is created."
        },
        {
          "name": "Recipient Deleted",
          "value": "recipient.deleted",
          "description": "Occurs whenever a recipient is deleted."
        },
        {
          "name": "Recipient Updated",
          "value": "recipient.updated",
          "description": "Occurs whenever a recipient is updated."
        },
        {
          "name": "Reporting Report_run.failed",
          "value": "reporting.report_run.failed",
          "description": "Occurs whenever a requested **ReportRun** failed to complete."
        },
        {
          "name": "Reporting Report_run.succeeded",
          "value": "reporting.report_run.succeeded",
          "description": "Occurs whenever a requested **ReportRun** completed succesfully."
        },
        {
          "name": "Reporting Report_type.updated",
          "value": "reporting.report_type.updated",
          "description": "Occurs whenever a **ReportType** is updated (typically to indicate that a new day's data has come available)."
        },
        {
          "name": "Review Closed",
          "value": "review.closed",
          "description": "Occurs whenever a review is closed. The review's reason field indicates why: approved, disputed, refunded, or refunded_as_fraud."
        },
        {
          "name": "Review Opened",
          "value": "review.opened",
          "description": "Occurs whenever a review is opened."
        },
        {
          "name": "Setup Intent.canceled",
          "value": "setup_intent.canceled",
          "description": "Occurs when a SetupIntent is canceled."
        },
        {
          "name": "Setup Intent.created",
          "value": "setup_intent.created",
          "description": "Occurs when a new SetupIntent is created."
        },
        {
          "name": "Setup Intent.setup_failed",
          "value": "setup_intent.setup_failed",
          "description": "Occurs when a SetupIntent has failed the attempt to setup a payment method."
        },
        {
          "name": "Setup Intent.succeeded",
          "value": "setup_intent.succeeded",
          "description": "Occurs when an SetupIntent has successfully setup a payment method."
        },
        {
          "name": "Sigma Scheduled_query_run.created",
          "value": "sigma.scheduled_query_run.created",
          "description": "Occurs whenever a Sigma scheduled query run finishes."
        },
        {
          "name": "Sku Created",
          "value": "sku.created",
          "description": "Occurs whenever a SKU is created."
        },
        {
          "name": "Sku Deleted",
          "value": "sku.deleted",
          "description": "Occurs whenever a SKU is deleted."
        },
        {
          "name": "Sku Updated",
          "value": "sku.updated",
          "description": "Occurs whenever a SKU is updated."
        },
        {
          "name": "Source Canceled",
          "value": "source.canceled",
          "description": "Occurs whenever a source is canceled."
        },
        {
          "name": "Source Chargeable",
          "value": "source.chargeable",
          "description": "Occurs whenever a source transitions to chargeable."
        },
        {
          "name": "Source Failed",
          "value": "source.failed",
          "description": "Occurs whenever a source fails."
        },
        {
          "name": "Source Mandate_notification",
          "value": "source.mandate_notification",
          "description": "Occurs whenever a source mandate notification method is set to manual."
        },
        {
          "name": "Source Refund_attributes_required",
          "value": "source.refund_attributes_required",
          "description": "Occurs whenever the refund attributes are required on a receiver source to process a refund or a mispayment."
        },
        {
          "name": "Source Transaction.created",
          "value": "source.transaction.created",
          "description": "Occurs whenever a source transaction is created."
        },
        {
          "name": "Source Transaction.updated",
          "value": "source.transaction.updated",
          "description": "Occurs whenever a source transaction is updated."
        },
        {
          "name": "Subscription Schedule.aborted",
          "value": "subscription_schedule.aborted",
          "description": "Occurs whenever a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency."
        },
        {
          "name": "Subscription Schedule.canceled",
          "value": "subscription_schedule.canceled",
          "description": "Occurs whenever a subscription schedule is canceled."
        },
        {
          "name": "Subscription Schedule.completed",
          "value": "subscription_schedule.completed",
          "description": "Occurs whenever a new subscription schedule is completed."
        },
        {
          "name": "Subscription Schedule.created",
          "value": "subscription_schedule.created",
          "description": "Occurs whenever a new subscription schedule is created."
        },
        {
          "name": "Subscription Schedule.expiring",
          "value": "subscription_schedule.expiring",
          "description": "Occurs 7 days before a subscription schedule will expire."
        },
        {
          "name": "Subscription Schedule.released",
          "value": "subscription_schedule.released",
          "description": "Occurs whenever a new subscription schedule is released."
        },
        {
          "name": "Subscription Schedule.updated",
          "value": "subscription_schedule.updated",
          "description": "Occurs whenever a subscription schedule is updated."
        },
        {
          "name": "Tax Rate.created",
          "value": "tax_rate.created",
          "description": "Occurs whenever a new tax rate is created."
        },
        {
          "name": "Tax Rate.updated",
          "value": "tax_rate.updated",
          "description": "Occurs whenever a tax rate is updated."
        },
        {
          "name": "Topup Canceled",
          "value": "topup.canceled",
          "description": "Occurs whenever a top-up is canceled."
        },
        {
          "name": "Topup Created",
          "value": "topup.created",
          "description": "Occurs whenever a top-up is created."
        },
        {
          "name": "Topup Failed",
          "value": "topup.failed",
          "description": "Occurs whenever a top-up fails."
        },
        {
          "name": "Topup Reversed",
          "value": "topup.reversed",
          "description": "Occurs whenever a top-up is reversed."
        },
        {
          "name": "Topup Succeeded",
          "value": "topup.succeeded",
          "description": "Occurs whenever a top-up succeeds."
        },
        {
          "name": "Transfer Created",
          "value": "transfer.created",
          "description": "Occurs whenever a transfer is created."
        },
        {
          "name": "Transfer Failed",
          "value": "transfer.failed",
          "description": "Occurs whenever a transfer failed."
        },
        {
          "name": "Transfer Paid",
          "value": "transfer.paid",
          "description": "Occurs after a transfer is paid. For Instant Payouts, the event will be sent on the next business day, although the funds should be received well beforehand."
        },
        {
          "name": "Transfer Reversed",
          "value": "transfer.reversed",
          "description": "Occurs whenever a transfer is reversed, including partial reversals."
        },
        {
          "name": "Transfer Updated",
          "value": "transfer.updated",
          "description": "Occurs whenever a transfer's description or metadata is updated."
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.supabase
package_name: n8n-nodes-base
display_name: Supabase
description: Add, get, delete and update data in a table
category: input
development_style: programmatic
version: 1
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Supabase node documentation
  description: Learn how to use the Supabase node in n8n. Follow technical documentation to integrate Supabase node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Supabase node

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

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

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

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

  ## Operations

  * Row
      * Create a new row
      * Delete a row
      * Get a row
      * Get all rows
      * Update a row

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Use Custom Schema",
      "name": "useCustomSchema",
      "type": "boolean",
      "default": false,
      "description": "Whether to use a database schema different from the default \"public\" schema (requires schema exposure in the <a href=\"https://supabase.com/docs/guides/api/using-custom-schemas?queryGroups=language&language=curl#exposing-custom-schemas\">Supabase API</a>)",
      "noDataExpression": true
    },
    {
      "displayName": "Schema",
      "name": "schema",
      "type": "string",
      "default": "public",
      "description": "Name of database schema to use for table",
      "displayOptions": {
        "show": {
          "useCustomSchema": [
            true
          ]
        }
      },
      "noDataExpression": false
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "row",
      "options": [
        {
          "name": "Row",
          "value": "row"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new row",
          "action": "Create a row"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a row",
          "action": "Delete a row"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a row",
          "action": "Get a row"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many rows",
          "action": "Get many rows"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a row",
          "action": "Update a row"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create",
            "delete",
            "get",
            "getAll",
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "useCustomSchema",
          "schema"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Select Type",
      "name": "filterType",
      "type": "options",
      "default": "manual",
      "options": [
        {
          "name": "Build Manually",
          "value": "manual"
        },
        {
          "name": "String",
          "value": "string"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Must Match",
      "name": "matchType",
      "type": "options",
      "default": "anyFilter",
      "options": [
        {
          "name": "Any Select Condition",
          "value": "anyFilter"
        },
        {
          "name": "All Select Conditions",
          "value": "allFilters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "filterType": [
            "manual"
          ]
        }
      }
    },
    {
      "displayName": "Select Conditions",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "description": "Filter to decide which rows get updated",
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "keyName",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableColumns"
              },
              "default": ""
            },
            {
              "displayName": "Condition",
              "name": "condition",
              "type": "options",
              "options": [
                {
                  "name": "Equals",
                  "value": "eq"
                },
                {
                  "name": "Full-Text",
                  "value": "fullText"
                },
                {
                  "name": "Greater Than",
                  "value": "gt"
                },
                {
                  "name": "Greater Than or Equal",
                  "value": "gte"
                },
                {
                  "name": "ILIKE operator",
                  "value": "ilike",
                  "description": "Use * in place of %"
                },
                {
                  "name": "Is",
                  "value": "is",
                  "description": "Checking for exact equality (null,true,false,unknown)"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                },
                {
                  "name": "Less Than or Equal",
                  "value": "lte"
                },
                {
                  "name": "LIKE operator",
                  "value": "like",
                  "description": "Use * in place of %"
                },
                {
                  "name": "Not Equals",
                  "value": "neq"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Search Function",
              "name": "searchFunction",
              "type": "options",
              "displayOptions": {
                "show": {
                  "condition": [
                    "fullText"
                  ]
                }
              },
              "options": [
                {
                  "name": "to_tsquery",
                  "value": "fts"
                },
                {
                  "name": "plainto_tsquery",
                  "value": "plfts"
                },
                {
                  "name": "phraseto_tsquery",
                  "value": "phfts"
                },
                {
                  "name": "websearch_to_tsquery",
                  "value": "wfts"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "keyValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "filterType": [
            "manual"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "See <a href=\"https://postgrest.org/en/stable/references/api/tables_views.html#horizontal-filtering\" target=\"_blank\">PostgREST guide</a> to creating filters",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "filterType": [
            "string"
          ]
        }
      }
    },
    {
      "displayName": "Filters (String)",
      "name": "filterString",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "filterType": [
            "string"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "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": {
          "resource": [
            "row"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create",
            "update"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "fieldId",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableColumns"
              },
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create",
            "update"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Select Type",
      "name": "filterType",
      "type": "options",
      "default": "manual",
      "options": [
        {
          "name": "Build Manually",
          "value": "manual"
        },
        {
          "name": "String",
          "value": "string"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Must Match",
      "name": "matchType",
      "type": "options",
      "default": "anyFilter",
      "options": [
        {
          "name": "Any Select Condition",
          "value": "anyFilter"
        },
        {
          "name": "All Select Conditions",
          "value": "allFilters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "delete"
          ],
          "filterType": [
            "manual"
          ]
        }
      }
    },
    {
      "displayName": "Select Conditions",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "description": "Filter to decide which rows get deleted",
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "keyName",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableColumns"
              },
              "default": ""
            },
            {
              "displayName": "Condition",
              "name": "condition",
              "type": "options",
              "options": [
                {
                  "name": "Equals",
                  "value": "eq"
                },
                {
                  "name": "Full-Text",
                  "value": "fullText"
                },
                {
                  "name": "Greater Than",
                  "value": "gt"
                },
                {
                  "name": "Greater Than or Equal",
                  "value": "gte"
                },
                {
                  "name": "ILIKE operator",
                  "value": "ilike",
                  "description": "Use * in place of %"
                },
                {
                  "name": "Is",
                  "value": "is",
                  "description": "Checking for exact equality (null,true,false,unknown)"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                },
                {
                  "name": "Less Than or Equal",
                  "value": "lte"
                },
                {
                  "name": "LIKE operator",
                  "value": "like",
                  "description": "Use * in place of %"
                },
                {
                  "name": "Not Equals",
                  "value": "neq"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Search Function",
              "name": "searchFunction",
              "type": "options",
              "displayOptions": {
                "show": {
                  "condition": [
                    "fullText"
                  ]
                }
              },
              "options": [
                {
                  "name": "to_tsquery",
                  "value": "fts"
                },
                {
                  "name": "plainto_tsquery",
                  "value": "plfts"
                },
                {
                  "name": "phraseto_tsquery",
                  "value": "phfts"
                },
                {
                  "name": "websearch_to_tsquery",
                  "value": "wfts"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "keyValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "delete"
          ],
          "filterType": [
            "manual"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "See <a href=\"https://postgrest.org/en/stable/references/api/tables_views.html#horizontal-filtering\" target=\"_blank\">PostgREST guide</a> to creating filters",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "delete"
          ],
          "filterType": [
            "string"
          ]
        }
      }
    },
    {
      "displayName": "Filters (String)",
      "name": "filterString",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "delete"
          ],
          "filterType": [
            "string"
          ]
        }
      }
    },
    {
      "displayName": "Select Conditions",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Name or ID",
              "name": "keyName",
              "type": "options",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableColumns"
              },
              "default": "",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>"
            },
            {
              "displayName": "Value",
              "name": "keyValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filter",
      "name": "filterType",
      "type": "options",
      "default": "manual",
      "options": [
        {
          "name": "None",
          "value": "none"
        },
        {
          "name": "Build Manually",
          "value": "manual"
        },
        {
          "name": "String",
          "value": "string"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Must Match",
      "name": "matchType",
      "type": "options",
      "default": "anyFilter",
      "options": [
        {
          "name": "Any Filter",
          "value": "anyFilter"
        },
        {
          "name": "All Filters",
          "value": "allFilters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "description": "Filter to decide which rows get retrieved",
      "options": [
        {
          "displayName": "Conditions",
          "name": "conditions",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "keyName",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableColumns"
              },
              "default": ""
            },
            {
              "displayName": "Condition",
              "name": "condition",
              "type": "options",
              "options": [
                {
                  "name": "Equals",
                  "value": "eq"
                },
                {
                  "name": "Full-Text",
                  "value": "fullText"
                },
                {
                  "name": "Greater Than",
                  "value": "gt"
                },
                {
                  "name": "Greater Than or Equal",
                  "value": "gte"
                },
                {
                  "name": "ILIKE operator",
                  "value": "ilike",
                  "description": "Use * in place of %"
                },
                {
                  "name": "Is",
                  "value": "is",
                  "description": "Checking for exact equality (null,true,false,unknown)"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                },
                {
                  "name": "Less Than or Equal",
                  "value": "lte"
                },
                {
                  "name": "LIKE operator",
                  "value": "like",
                  "description": "Use * in place of %"
                },
                {
                  "name": "Not Equals",
                  "value": "neq"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Search Function",
              "name": "searchFunction",
              "type": "options",
              "displayOptions": {
                "show": {
                  "condition": [
                    "fullText"
                  ]
                }
              },
              "options": [
                {
                  "name": "to_tsquery",
                  "value": "fts"
                },
                {
                  "name": "plainto_tsquery",
                  "value": "plfts"
                },
                {
                  "name": "phraseto_tsquery",
                  "value": "phfts"
                },
                {
                  "name": "websearch_to_tsquery",
                  "value": "wfts"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "keyValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "manual"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "See <a href=\"https://postgrest.org/en/stable/references/api/tables_views.html#horizontal-filtering\" target=\"_blank\">PostgREST guide</a> to creating filters",
      "name": "jsonNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "string"
          ]
        }
      }
    },
    {
      "displayName": "Filters (String)",
      "name": "filterString",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ],
          "filterType": [
            "string"
          ]
        }
      }
    }
  ]

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

credentials_required:
  [
    {
      "name": "supabaseApi",
      "required": true,
      "testedBy": "supabaseApiCredentialTest"
    }
  ]


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

  # SurveyMonkey Trigger node

  [SurveyMonkey](https://www.surveymonkey.com/){:target=_blank .external-link} is an online cloud-based SaaS survey platform that also provides a suite of paid back-end programs.

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Type",
      "name": "objectType",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Collector",
          "value": "collector"
        },
        {
          "name": "Survey",
          "value": "survey"
        }
      ],
      "required": true
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Collector Created",
          "value": "collector_created",
          "description": "A collector is created"
        },
        {
          "name": "Collector Deleted",
          "value": "collector_deleted",
          "description": "A collector is deleted"
        },
        {
          "name": "Collector Updated",
          "value": "collector_updated",
          "description": "A collector is updated"
        },
        {
          "name": "Response Completed",
          "value": "response_completed",
          "description": "A survey response is completed"
        },
        {
          "name": "Response Created",
          "value": "response_created",
          "description": "A respondent begins a survey"
        },
        {
          "name": "Response Deleted",
          "value": "response_deleted",
          "description": "A response is deleted"
        },
        {
          "name": "Response Disqualified",
          "value": "response_disqualified",
          "description": "A survey response is disqualified"
        },
        {
          "name": "Response Overquota",
          "value": "response_overquota",
          "description": "A response is over a survey’s quota"
        },
        {
          "name": "Response Updated",
          "value": "response_updated",
          "description": "A survey response is updated"
        },
        {
          "name": "Survey Created",
          "value": "survey_created",
          "description": "A survey is created"
        },
        {
          "name": "Survey Deleted",
          "value": "survey_deleted",
          "description": "A survey is deleted"
        },
        {
          "name": "Survey Updated",
          "value": "survey_updated",
          "description": "A survey is updated"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "objectType": [
            "survey"
          ]
        }
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Collector Deleted",
          "value": "collector_deleted",
          "description": "A collector is deleted"
        },
        {
          "name": "Collector Updated",
          "value": "collector_updated",
          "description": "A collector is updated"
        },
        {
          "name": "Response Completed",
          "value": "response_completed",
          "description": "A survey response is completed"
        },
        {
          "name": "Response Created",
          "value": "response_created",
          "description": "A respondent begins a survey"
        },
        {
          "name": "Response Deleted",
          "value": "response_deleted",
          "description": "A response is deleted"
        },
        {
          "name": "Response Disqualified",
          "value": "response_disqualified",
          "description": "A survey response is disqualified"
        },
        {
          "name": "Response Overquota",
          "value": "response_overquota",
          "description": "A response is over a survey’s quota"
        },
        {
          "name": "Response Updated",
          "value": "response_updated",
          "description": "A survey response is updated"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "objectType": [
            "collector"
          ]
        }
      }
    },
    {
      "displayName": "Survey Names or IDs",
      "name": "surveyIds",
      "type": "multiOptions",
      "default": [],
      "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "objectType": [
            "survey"
          ]
        },
        "hide": {
          "event": [
            "survey_created"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSurveys"
      }
    },
    {
      "displayName": "Survey Name or ID",
      "name": "surveyId",
      "type": "options",
      "default": [],
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "objectType": [
            "collector"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSurveys"
      }
    },
    {
      "displayName": "Collector Names or IDs",
      "name": "collectorIds",
      "type": "multiOptions",
      "default": [],
      "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "objectType": [
            "collector"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCollectors",
        "loadOptionsDependsOn": [
          "surveyId"
        ]
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the webhook-data only contain the IDs. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "event": [
            "response_completed"
          ]
        }
      }
    },
    {
      "displayName": "Only Answers",
      "name": "onlyAnswers",
      "type": "boolean",
      "default": true,
      "description": "Whether to return only the answers of the form and not any of the other data",
      "displayOptions": {
        "show": {
          "resolveData": [
            true
          ],
          "event": [
            "response_completed"
          ]
        }
      }
    }
  ]

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


node_type: nodes-base.switch
package_name: n8n-nodes-base
display_name: Switch
description: Route items depending on defined expression or rules
category: transform
development_style: programmatic
version: 3.2
operations: []
credentials_required: []
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Switch
  description: Documentation for the Switch node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  ---

  # Switch

  Use the Switch node to route a workflow conditionally based on comparison operations. It's similar to the [IF](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) node, but supports multiple output routes.

  ## Node parameters

  Select the **Mode** the node should use:

  * **Rules**: Select this mode to build a matching rule for each output.
  * **Expression**: Select this mode to write an expression to return the output index programmatically.

  Node configuration depends on the **Mode** you select.

  ### Rules

  To configure the node with this operation, use these parameters:

  * Create **Routing Rules** to define comparison conditions.
      * Use the data type dropdown to select the data type and comparison operation type for your condition. For example, to create a rules for dates after a particular date, select **Date & Time > is after**.
      * The fields and values to enter into the condition change based on the data type and comparison you select. Refer to [Available data type comparisons](#available-data-type-comparisons) for a full list of all comparisons by data type.
  * **Rename Output**: Turn this control on to rename the output field to put matching data into. Enter your desired **Output Name**.

  Select **Add Routing Rule** to add more rules.

  #### Rule options

  You can further configure the node with this operation using these **Options**:

  - **Fallback Output**: Choose how to route the workflow when an item doesn't match any of the rules or conditions.
      - **None**: Ignore the item. This is the default behavior.
      - **Extra Output**: Send items to an extra, separate output.
      - **Output 0**: Send items to the same output as those matching the first rule.
  - **Ignore Case**: Set whether to ignore letter case when evaluating conditions (turned on) or enforce letter case (turned off).
  - **Less Strict Type Validation**: Set whether you want n8n to attempt to convert value types based on the operator you choose (turned on) or not (turned off).
  - **Send data to all matching outputs**: Set whether to send data to all outputs meeting conditions (turned on) or whether to send the data to the first output matching the conditions (turned off).

  ### Expression

  To configure the node with this operation, use these parameters:

  - **Number of Outputs**: Set how many outputs the node should have.
  - **Output Index**: Create an expression to calculate which input item should be routed to which output. The expression must return a number.

  ## Templates and examples

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

  ## Related resources

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

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

properties_schema:
  [
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "rules",
      "description": "How data should be routed",
      "options": [
        {
          "name": "Rules",
          "value": "rules",
          "description": "Build a matching rule for each output"
        },
        {
          "name": "Expression",
          "value": "expression",
          "description": "Write an expression to return the output index"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Number of Outputs",
      "name": "numberOutputs",
      "type": "number",
      "default": 4,
      "description": "How many outputs to create",
      "displayOptions": {
        "show": {
          "mode": [
            "expression"
          ]
        }
      }
    },
    {
      "displayName": "Output Index",
      "name": "output",
      "type": "number",
      "default": "={{}}",
      "description": "The output index to send the input item to. Use an expression to calculate which input item should be routed to which output. The expression must return a number.",
      "displayOptions": {
        "show": {
          "mode": [
            "expression"
          ]
        }
      }
    },
    {
      "displayName": "Routing Rules",
      "name": "rules",
      "type": "fixedCollection",
      "default": {
        "values": [
          {
            "conditions": {
              "options": {
                "caseSensitive": true,
                "leftValue": "",
                "typeValidation": "strict"
              },
              "conditions": [
                {
                  "leftValue": "",
                  "rightValue": "",
                  "operator": {
                    "type": "string",
                    "operation": "equals"
                  }
                }
              ],
              "combinator": "and"
            }
          }
        ]
      },
      "options": [
        {
          "name": "values",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "filter",
              "default": {},
              "typeOptions": {
                "multipleValues": false,
                "filter": {
                  "caseSensitive": "={{!$parameter.options.ignoreCase}}",
                  "typeValidation": "={{ ($nodeVersion < 3.1 ? $parameter.options.looseTypeValidation :  $parameter.looseTypeValidation) ? \"loose\" : \"strict\" }}",
                  "version": "={{ $nodeVersion >= 3.2 ? 2 : 1 }}"
                }
              }
            },
            {
              "displayName": "Rename Output",
              "name": "renameOutput",
              "type": "boolean",
              "default": false
            },
            {
              "displayName": "Output Name",
              "name": "outputKey",
              "type": "string",
              "default": "",
              "description": "The label of output to which to send data to if rule matches",
              "displayOptions": {
                "show": {
                  "renameOutput": [
                    true
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "rules"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Convert types where required",
      "name": "looseTypeValidation",
      "type": "boolean",
      "default": false,
      "description": "If the type of an expression doesn't match the type of the comparison, n8n will try to cast the expression to the required type. E.g. for booleans <code>\"false\"</code> or <code>0</code> will be cast to <code>false</code>",
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "gte": 3.1
              }
            }
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fallback Output",
          "name": "fallbackOutput",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "rules.values",
              "/rules",
              "/rules.values"
            ],
            "loadOptionsMethod": "getFallbackOutputOptions"
          },
          "default": "none",
          "description": "If no rule matches the item will be sent to this output, by default they will be ignored"
        },
        {
          "displayName": "Ignore Case",
          "description": "Whether to ignore letter case when evaluating conditions",
          "name": "ignoreCase",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Convert types where required",
          "description": "If the type of an expression doesn't match the type of the comparison, n8n will try to cast the expression to the required type. E.g. for booleans <code>\"false\"</code> or <code>0</code> will be cast to <code>false</code>",
          "name": "looseTypeValidation",
          "type": "boolean",
          "default": true,
          "displayOptions": {
            "show": {
              "@version": [
                {
                  "_cnd": {
                    "lt": 3.1
                  }
                }
              ]
            }
          }
        },
        {
          "displayName": "Rename Fallback Output",
          "name": "renameFallbackOutput",
          "type": "string",
          "placeholder": "e.g. Fallback",
          "default": "",
          "displayOptions": {
            "show": {
              "fallbackOutput": [
                "extra"
              ]
            }
          }
        },
        {
          "displayName": "Send data to all matching outputs",
          "name": "allMatchingOutputs",
          "type": "boolean",
          "default": false,
          "description": "Whether to send data to all outputs meeting conditions (and not just the first one)"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "rules"
          ]
        }
      }
    }
  ]


node_type: nodes-base.syncroMsp
package_name: n8n-nodes-base
display_name: SyncroMSP
description: Manage contacts, tickets and more from Syncro MSP
category: output
development_style: programmatic
version: 1
updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SyncroMSP node documentation
  description: Learn how to use the SyncroMSP node in n8n. Follow technical documentation to integrate SyncroMSP node into your workflows.
  contentType: [integration, reference]
  ---

  # SyncroMSP node

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

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

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

  ## Operations

  * Contact
      * Create new contact
      * Delete contact
      * Retrieve contact
      * Retrieve all contacts
      * Update contact
  * Customer
      * Create new customer
      * Delete customer
      * Retrieve customer
      * Retrieve all customers
      * Update customer
  * RMM
      * Create new RMM Alert
      * Delete RMM Alert
      * Retrieve RMM Alert
      * Retrieve all RMM Alerts
      * Mute RMM Alert
  * Ticket
      * Create new ticket
      * Delete ticket
      * Retrieve ticket
      * Retrieve all tickets
      * Update ticket

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "RMM",
          "value": "rmm"
        },
        {
          "name": "Ticket",
          "value": "ticket"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create new customer",
          "action": "Create a customer"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete customer",
          "action": "Delete a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve customer",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many customers",
          "action": "Get many customers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update customer",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 25,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Business Name",
          "name": "businessName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Include Disabled",
          "name": "includeDisabled",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Last Name",
          "name": "lastname",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Search Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "John Doe",
          "description": "Search query, it can be anything related to customer data like name etc"
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "string",
          "default": "",
          "placeholder": "firstname ASC",
          "description": "Customer field to order by, eg: \"firstname ASC\", \"city DESC\" etc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Cutomer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "Get specific customer by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ZIP",
                  "name": "zip",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Business Name",
          "name": "businessName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Get SMS",
          "name": "getSms",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Invoice Emails",
          "name": "invoiceCcEmails",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Email"
          },
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastname",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "No Email",
          "name": "noEmail",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notification Email",
          "name": "notificationEmail",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "noEmail": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Referred By",
          "name": "referredBy",
          "type": "string",
          "default": "",
          "description": "Source from which customer is referred to the platform like Linkedin, Google, Customer name etc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "Delete a specific customer by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ZIP",
                  "name": "zip",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Business Name",
          "name": "businessName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Get SMS",
          "name": "getSms",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Invoice Emails",
          "name": "invoiceCcEmails",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Email"
          },
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "No Email",
          "name": "noEmail",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notification Email",
          "name": "notificationEmail",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "noEmail": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Referred By",
          "name": "referredBy",
          "type": "string",
          "default": "",
          "description": "Source from which customer is referred to the platform like Linkedin, Google, Customer name etc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create new ticket",
          "action": "Create a ticket"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete ticket",
          "action": "Delete a ticket"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve ticket",
          "action": "Get a ticket"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many tickets",
          "action": "Get many tickets"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update ticket",
          "action": "Update a ticket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 25,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Search Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "John Doe",
          "description": "Search query, it can be anything related to ticket data like user etc"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Customer Reply",
              "value": "Customer Reply"
            },
            {
              "name": "In Progress",
              "value": "In Progress"
            },
            {
              "name": "New",
              "value": "New"
            },
            {
              "name": "Resolved",
              "value": "Resolved"
            },
            {
              "name": "Scheduled",
              "value": "Scheduled"
            },
            {
              "name": "Waiting for Parts",
              "value": "Waiting for Parts"
            },
            {
              "name": "Waiting on Customer",
              "value": "Waiting on Customer"
            }
          ],
          "default": "New"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Asset ID",
          "name": "assetId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Assign to Contact",
          "name": "contactId",
          "type": "string",
          "default": "",
          "description": "The ID of the contact you want to assign the ticket to"
        },
        {
          "displayName": "Issue Type",
          "name": "issueType",
          "type": "options",
          "options": [
            {
              "name": "Contract Work",
              "value": "Contract Work"
            },
            {
              "name": "Network Project",
              "value": "Network Project"
            },
            {
              "name": "Other",
              "value": "Other"
            },
            {
              "name": "Regular Maintenance",
              "value": "Regular Maintenance"
            },
            {
              "name": "Remote Support",
              "value": "Remote Support"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Customer Reply",
              "value": "Customer Reply"
            },
            {
              "name": "In Progress",
              "value": "In Progress"
            },
            {
              "name": "New",
              "value": "New"
            },
            {
              "name": "Resolved",
              "value": "Resolved"
            },
            {
              "name": "Scheduled",
              "value": "Scheduled"
            },
            {
              "name": "Waiting for Parts",
              "value": "Waiting for Parts"
            },
            {
              "name": "Waiting on Customer",
              "value": "Waiting on Customer"
            }
          ],
          "default": "New",
          "description": "If used along the parameter Search Query, only Search Query will be applied"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "ticketId",
      "type": "string",
      "default": "",
      "description": "Get specific customer by ID",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "ticketId",
      "type": "string",
      "default": "",
      "description": "Delete a specific customer by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Ticket ID",
      "name": "ticketId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Asset ID",
          "name": "assetId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Assign to Contact",
          "name": "contactId",
          "type": "string",
          "default": "",
          "description": "The ID of the contact you want to assign the ticket to"
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Issue Type",
          "name": "issueType",
          "type": "options",
          "options": [
            {
              "name": "Contract Work",
              "value": "Contract Work"
            },
            {
              "name": "Network Project",
              "value": "Network Project"
            },
            {
              "name": "Other",
              "value": "Other"
            },
            {
              "name": "Regular Maintenance",
              "value": "Regular Maintenance"
            },
            {
              "name": "Remote Support",
              "value": "Remote Support"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Customer Reply",
              "value": "Customer Reply"
            },
            {
              "name": "In Progress",
              "value": "In Progress"
            },
            {
              "name": "New",
              "value": "New"
            },
            {
              "name": "Resolved",
              "value": "Resolved"
            },
            {
              "name": "Scheduled",
              "value": "Scheduled"
            },
            {
              "name": "Waiting for Parts",
              "value": "Waiting for Parts"
            },
            {
              "name": "Waiting on Customer",
              "value": "Waiting on Customer"
            }
          ],
          "default": "New"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create new contact",
          "action": "Create a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many contacts",
          "action": "Get many contacts"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update contact",
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 25,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ZIP",
                  "name": "zip",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Get specific contact by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ZIP",
                  "name": "zip",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "Delete a specific contact by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create new RMM Alert",
          "action": "Create an RMM alert"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete RMM Alert",
          "action": "Delete an RMM alert"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve RMM Alert",
          "action": "Get an RMM alert"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many RMM Alerts",
          "action": "Get many RMM alerts"
        },
        {
          "name": "Mute",
          "value": "mute",
          "description": "Mute RMM Alert",
          "action": "Mute an RMM alert"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 25,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Resolved",
              "value": "resolved"
            }
          ],
          "default": "all"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "RMM Alert ID",
      "name": "alertId",
      "type": "string",
      "default": "",
      "description": "Get specific RMM alert by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Asset ID",
      "name": "assetId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Description",
      "name": "description",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Resolved",
          "name": "resolved",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "RMM Alert ID",
      "name": "alertId",
      "type": "string",
      "default": "",
      "description": "Delete the RMM alert by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "RMM Alert ID",
      "name": "alertId",
      "type": "string",
      "default": "",
      "description": "Mute the RMM alert by ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "mute"
          ]
        }
      }
    },
    {
      "displayName": "Mute Period",
      "name": "muteFor",
      "type": "options",
      "default": "",
      "description": "Length of time to mute alert for",
      "options": [
        {
          "name": "1 Hour",
          "value": "1-hour"
        },
        {
          "name": "1 Day",
          "value": "1-day"
        },
        {
          "name": "2 Days",
          "value": "2-days"
        },
        {
          "name": "1 Week",
          "value": "1-week"
        },
        {
          "name": "2 Weeks",
          "value": "2-weeks"
        },
        {
          "name": "1 Month",
          "value": "1-month"
        },
        {
          "name": "Forever",
          "value": "forever"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "rmm"
          ],
          "operation": [
            "mute"
          ]
        }
      }
    }
  ]

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

credentials_required:
  [
    {
      "name": "syncroMspApi",
      "required": true,
      "testedBy": "syncroMspApiCredentialTest"
    }
  ]


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

updated_at: 2025-06-18 20:35:39
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Taiga node documentation
  description: Learn how to use the Taiga node in n8n. Follow technical documentation to integrate Taiga node into your workflows.
  contentType: [integration, reference]
  ---

  # Taiga node

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

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

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

  ## Operations

  - **Issue**
      - Create an issue
      - Delete an issue
      - Get an issue
      - Get all issues
      - Update an issue

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "issue",
      "options": [
        {
          "name": "Epic",
          "value": "epic"
        },
        {
          "name": "Issue",
          "value": "issue"
        },
        {
          "name": "Task",
          "value": "task"
        },
        {
          "name": "User Story",
          "value": "userStory"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an epic",
          "action": "Create an epic"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an epic",
          "action": "Delete an epic"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an epic",
          "action": "Get an epic"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many epics",
          "action": "Get many epics"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an epic",
          "action": "Update an epic"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the epic belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user to assign the epic to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the epic is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "0000FF",
          "description": "Color code in hexadecimal notation"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the issue is blocked"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Epic ID",
      "name": "epicId",
      "type": "string",
      "default": "",
      "description": "ID of the epic to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Epic ID",
      "name": "epicId",
      "type": "string",
      "default": "",
      "description": "ID of the epic to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the epic belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "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": [
            "epic"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user whom the epic is assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Is Closed",
          "name": "statusIsClosed",
          "description": "Whether the epic is closed",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to set the epic to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Epic ID",
      "name": "epicId",
      "type": "string",
      "default": "",
      "description": "ID of the epic to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user to whom the epic is assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the epic is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "0000FF",
          "description": "Color code in hexadecimal notation"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the epic is blocked"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "epic"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an issue",
          "action": "Create an issue"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an issue",
          "action": "Delete an issue"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an issue",
          "action": "Get an issue"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many issues",
          "action": "Get many issues"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an issue",
          "action": "Update an issue"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the issue belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user to whom the issue is assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the issue is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the issue is blocked"
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the issue. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priority",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getPriorities"
          },
          "default": ""
        },
        {
          "displayName": "Severity Name or ID",
          "name": "severity",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getSeverities"
          },
          "default": ""
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getIssueStatuses"
          },
          "default": "",
          "description": "ID of the status of the issue. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTypes"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of the issue to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of the issue to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the issue belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "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": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "description": "ID of the user to assign the issue to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "description": "Field to order the issues by",
          "type": "options",
          "options": [
            {
              "name": "Assigned To",
              "value": "assigned_to"
            },
            {
              "name": "Created Date",
              "value": "created_date"
            },
            {
              "name": "Modified Date",
              "value": "modified_date"
            },
            {
              "name": "Owner",
              "value": "owner"
            },
            {
              "name": "Priority",
              "value": "priority"
            },
            {
              "name": "Severity",
              "value": "severity"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Subject",
              "value": "subject"
            },
            {
              "name": "Type",
              "value": "type"
            }
          ],
          "default": "assigned_to"
        },
        {
          "displayName": "Owner Name or ID",
          "name": "owner",
          "description": "ID of the owner of the issue. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priority",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getPriorities"
          },
          "default": ""
        },
        {
          "displayName": "Role Name or ID",
          "name": "role",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getRoles"
          },
          "default": ""
        },
        {
          "displayName": "Severity Name or ID",
          "name": "severity",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getSeverities"
          },
          "default": ""
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "description": "ID of the status of the issue. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getIssueStatuses"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTypes"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to set the issue to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of the issue to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user whom the issue is assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the issue is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the issue is blocked"
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the issue. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priority",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getPriorities"
          },
          "default": ""
        },
        {
          "displayName": "Severity Name or ID",
          "name": "severity",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getSeverities"
          },
          "default": ""
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getIssueStatuses"
          },
          "default": "",
          "description": "ID of the status of the issue. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTypes"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a task",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a task",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tasks",
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a task",
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the task belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user to whom the task is assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the task is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the task is blocked"
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTaskStatuses"
          },
          "default": "",
          "description": "ID of the status of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Taskboard Order",
          "name": "taskboard_order",
          "type": "number",
          "default": 1,
          "description": "Order of the task in the taskboard",
          "typeOptions": {
            "minValue": 1
          }
        },
        {
          "displayName": "User Story Name or ID",
          "name": "user_story",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUserStories"
          },
          "default": "",
          "description": "ID of the user story of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "User Story Order",
          "name": "us_order",
          "type": "number",
          "default": 1,
          "description": "Order of the task in the user story",
          "typeOptions": {
            "minValue": 1
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the task belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "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",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user whom the task is assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Is Closed",
          "name": "statusIsClosed",
          "description": "Whether the task is closed",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Owner Name or ID",
          "name": "owner",
          "description": "ID of the owner of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Role Name or ID",
          "name": "role",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getRoles"
          },
          "default": ""
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "description": "ID of the status of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTaskStatuses"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "User Story Name or ID",
          "name": "userStory",
          "description": "ID of the user story to which the task belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUserStories"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to set the task to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTypes"
          },
          "default": "",
          "description": "ID of the user to assign the task to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the task is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the task is blocked"
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTaskStatuses"
          },
          "default": "",
          "description": "ID of the status of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "User Story Name or ID",
          "name": "user_story",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUserStories"
          },
          "default": "",
          "description": "ID of the user story of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "User Story Order",
          "name": "us_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the task in the user story"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Taskboard Order",
          "name": "taskboard_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the task in the taskboard"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a user story",
          "action": "Create a user story"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user story",
          "action": "Delete a user story"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a user story",
          "action": "Get a user story"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many user stories",
          "action": "Get many user stories"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user story",
          "action": "Update a user story"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the user story belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user to whom the user story is assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Backlog Order",
          "name": "backlog_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the user story in the backlog"
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the user story is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the user story is blocked"
        },
        {
          "displayName": "Kanban Order",
          "name": "kanban_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the user story in the kanban"
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the user story. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Sprint Order",
          "name": "sprint_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the user story in the milestone"
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUserStoryStatuses"
          },
          "default": "",
          "description": "ID of the status of the user story. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTypes"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User Story ID",
      "name": "userStoryId",
      "type": "string",
      "default": "",
      "description": "ID of the user story to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User Story ID",
      "name": "userStoryId",
      "type": "string",
      "default": "",
      "description": "ID of the user story to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to which the user story belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "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": [
            "userStory"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "description": "ID of the user whom the user story is assigned to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": ""
        },
        {
          "displayName": "Epic Name or ID",
          "name": "epic",
          "description": "ID of the epic to which the user story belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getEpics"
          },
          "default": ""
        },
        {
          "displayName": "Is Closed",
          "name": "statusIsClosed",
          "description": "Whether the user story is closed",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Is Archived",
          "name": "statusIsArchived",
          "description": "Whether the user story has been archived",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the user story. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Role Name or ID",
          "name": "role",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getRoles"
          },
          "default": ""
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "description": "ID of the status of the user story. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUserStoryStatuses"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "ID of the project to set the user story to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "User Story ID",
      "name": "userStoryId",
      "type": "string",
      "default": "",
      "description": "ID of the user story to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUsers"
          },
          "default": "",
          "description": "ID of the user to assign the the user story to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Backlog Order",
          "name": "backlog_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the user story in the backlog"
        },
        {
          "displayName": "Blocked Note",
          "name": "blocked_note",
          "type": "string",
          "default": "",
          "description": "Reason why the user story is blocked. Requires \"Is Blocked\" toggle to be enabled."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Blocked",
          "name": "is_blocked",
          "type": "boolean",
          "default": false,
          "description": "Whether the user story is blocked"
        },
        {
          "displayName": "Kanban Order",
          "name": "kanban_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the user story in the kanban"
        },
        {
          "displayName": "Milestone (Sprint) Name or ID",
          "name": "milestone",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getMilestones"
          },
          "default": "",
          "description": "ID of the milestone of the user story. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Sprint Order",
          "name": "sprint_order",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Order of the user story in the milestone"
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getUserStoryStatuses"
          },
          "default": "",
          "description": "ID of the status of the user story. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "projectId"
            ],
            "loadOptionsMethod": "getTypes"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userStory"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an epic"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an epic"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an epic"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many epics"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an epic"
    }
  ]


