# nodes

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
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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",
      "resource": "player"
    },
    {
      "operation": "currentlyPlaying",
      "name": "Currently Playing",
      "description": "Get your currently playing track",
      "resource": "player"
    },
    {
      "operation": "nextSong",
      "name": "Next Song",
      "description": "Skip to your next track",
      "resource": "player"
    },
    {
      "operation": "pause",
      "name": "Pause",
      "description": "Pause your music",
      "resource": "player"
    },
    {
      "operation": "previousSong",
      "name": "Previous Song",
      "description": "Skip to your previous song",
      "resource": "player"
    },
    {
      "operation": "recentlyPlayed",
      "name": "Recently Played",
      "description": "Get your recently played tracks",
      "resource": "player"
    },
    {
      "operation": "resume",
      "name": "Resume",
      "description": "Resume playback on the current active device",
      "resource": "player"
    },
    {
      "operation": "volume",
      "name": "Set Volume",
      "description": "Set volume on the current active device",
      "resource": "player"
    },
    {
      "operation": "startMusic",
      "name": "Start Music",
      "description": "Start playing a playlist, artist, or album",
      "resource": "player"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an album by URI or ID",
      "resource": "album"
    },
    {
      "operation": "getNewReleases",
      "name": "Get New Releases",
      "description": "Get a list of new album releases",
      "resource": "album"
    },
    {
      "operation": "getTracks",
      "name": "Get Tracks",
      "description": "Get an album's tracks by URI or ID",
      "resource": "album"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search albums by keyword",
      "resource": "album"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an artist by URI or ID",
      "resource": "artist"
    },
    {
      "operation": "getAlbums",
      "name": "Get Albums",
      "description": "Get an artist's albums by URI or ID",
      "resource": "artist"
    },
    {
      "operation": "getRelatedArtists",
      "name": "Get Related Artists",
      "description": "Get an artist's related artists by URI or ID",
      "resource": "artist"
    },
    {
      "operation": "getTopTracks",
      "name": "Get Top Tracks",
      "description": "Get an artist's top tracks by URI or ID",
      "resource": "artist"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search artists by keyword",
      "resource": "artist"
    },
    {
      "operation": "add",
      "name": "Add an Item",
      "description": "Add tracks to a playlist by track and playlist URI or ID",
      "resource": "playlist"
    },
    {
      "operation": "create",
      "name": "Create a Playlist",
      "description": "Create a new playlist",
      "resource": "playlist"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a playlist by URI or ID",
      "resource": "playlist"
    },
    {
      "operation": "getUserPlaylists",
      "name": "Get the User's Playlists",
      "description": "Get a user's playlists",
      "resource": "playlist"
    },
    {
      "operation": "getTracks",
      "name": "Get Tracks",
      "description": "Get a playlist's tracks by URI or ID",
      "resource": "playlist"
    },
    {
      "operation": "delete",
      "name": "Remove an Item",
      "description": "Remove tracks from a playlist by track and playlist URI or ID",
      "resource": "playlist"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search playlists by keyword",
      "resource": "playlist"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a track by its URI or ID",
      "resource": "track"
    },
    {
      "operation": "getAudioFeatures",
      "name": "Get Audio Features",
      "description": "Get audio features for a track by URI or ID",
      "resource": "track"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search tracks by keyword",
      "resource": "track"
    },
    {
      "operation": "getLikedTracks",
      "name": "Get Liked Tracks",
      "description": "Get the user's liked tracks",
      "resource": "library"
    },
    {
      "operation": "getFollowingArtists",
      "name": "Get Following Artists",
      "description": "Get your followed artists",
      "resource": "myData"
    }
  ]


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: []
outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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."
        },
        {
          "displayName": "Skip Records With Errors",
          "name": "skipRecordsWithErrors",
          "type": "fixedCollection",
          "default": {
            "value": {
              "enabled": true,
              "maxSkippedRecords": -1
            }
          },
          "options": [
            {
              "displayName": "Value",
              "name": "value",
              "values": [
                {
                  "displayName": "Enabled",
                  "name": "enabled",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to skip records with errors when reading from file"
                },
                {
                  "displayName": "Max Skipped Records",
                  "name": "maxSkippedRecords",
                  "type": "number",
                  "default": -1,
                  "description": "The maximum number of records that can be skipped, will throw an error if exceeded. Set to -1 to remove limit."
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/fileFormat": [
                "csv"
              ]
            }
          }
        }
      ],
      "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: []
outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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
outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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",
      "resource": "command"
    },
    {
      "operation": "download",
      "name": "Download",
      "description": "Download a file",
      "resource": "file"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Upload a file",
      "resource": "file"
    }
  ]

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.stackbyTool
package_name: n8n-nodes-base
display_name: Stackby Tool
description: Read, write, and delete data in Stackby (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "stackbyApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.stackby
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": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Stackby"
    },
    {
      "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.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
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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.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: []
outputs: []
updated_at: 2026-07-16 12:10:22
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.storyblokTool
package_name: n8n-nodes-base
display_name: Storyblok Tool
description: Consume Storyblok API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.storyblok
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": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Storyblok"
    },
    {
      "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",
      "resource": "story"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many stories",
      "resource": "story"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a story",
      "resource": "story"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a story",
      "resource": "story"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many stories",
      "resource": "story"
    },
    {
      "operation": "publish",
      "name": "Publish",
      "description": "Publish a story",
      "resource": "story"
    },
    {
      "operation": "unpublish",
      "name": "Unpublish",
      "description": "Unpublish a story",
      "resource": "story"
    }
  ]

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


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

updated_at: 2026-07-16 12:10:22
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",
      "resource": "story"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many stories",
      "resource": "story"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a story",
      "resource": "story"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a story",
      "resource": "story"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many stories",
      "resource": "story"
    },
    {
      "operation": "publish",
      "name": "Publish",
      "description": "Publish a story",
      "resource": "story"
    },
    {
      "operation": "unpublish",
      "name": "Unpublish",
      "description": "Unpublish a story",
      "resource": "story"
    }
  ]

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


node_type: nodes-base.strapiTool
package_name: n8n-nodes-base
display_name: Strapi Tool
description: Consume Strapi API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.strapi
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": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to make API requests and fetch data"
    },
    {
      "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",
      "resource": "entry"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an entry",
      "resource": "entry"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an entry",
      "resource": "entry"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many entries",
      "resource": "entry"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an entry",
      "resource": "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.strapi
package_name: n8n-nodes-base
display_name: Strapi
description: Consume Strapi API
category: input
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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",
      "resource": "entry"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an entry",
      "resource": "entry"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an entry",
      "resource": "entry"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many entries",
      "resource": "entry"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an entry",
      "resource": "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.stravaTool
package_name: n8n-nodes-base
display_name: Strava Tool
description: Consume Strava API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1.1
credentials_required:
  [
  {
  "name": "stravaOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.strava
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": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Strava"
    },
    {
      "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",
      "resource": "activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an activity",
      "resource": "activity"
    },
    {
      "operation": "getComments",
      "name": "Get Comments",
      "description": "Get all activity comments",
      "resource": "activity"
    },
    {
      "operation": "getKudos",
      "name": "Get Kudos",
      "description": "Get all activity kudos",
      "resource": "activity"
    },
    {
      "operation": "getLaps",
      "name": "Get Laps",
      "description": "Get all activity laps",
      "resource": "activity"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many activities",
      "resource": "activity"
    },
    {
      "operation": "getStreams",
      "name": "Get Streams",
      "description": "Get activity streams",
      "resource": "activity"
    },
    {
      "operation": "getZones",
      "name": "Get Zones",
      "description": "Get all activity zones",
      "resource": "activity"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity",
      "resource": "activity"
    }
  ]


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
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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",
      "resource": "activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an activity",
      "resource": "activity"
    },
    {
      "operation": "getComments",
      "name": "Get Comments",
      "description": "Get all activity comments",
      "resource": "activity"
    },
    {
      "operation": "getKudos",
      "name": "Get Kudos",
      "description": "Get all activity kudos",
      "resource": "activity"
    },
    {
      "operation": "getLaps",
      "name": "Get Laps",
      "description": "Get all activity laps",
      "resource": "activity"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many activities",
      "resource": "activity"
    },
    {
      "operation": "getStreams",
      "name": "Get Streams",
      "description": "Get activity streams",
      "resource": "activity"
    },
    {
      "operation": "getZones",
      "name": "Get Zones",
      "description": "Get all activity zones",
      "resource": "activity"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity",
      "resource": "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
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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.stripeTool
package_name: n8n-nodes-base
display_name: Stripe Tool
description: Consume the Stripe API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "stripeApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.stripe
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": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Stripe"
    },
    {
      "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": "Meter Event",
          "value": "meterEvent"
        },
        {
          "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": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a meter event",
          "action": "Create a meter event"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Event Name",
      "name": "eventName",
      "type": "string",
      "default": "",
      "description": "The name of the meter event. Corresponds with the event_name field on a meter.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "The Stripe customer ID associated with this meter event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "number",
      "default": 1,
      "description": "The value of the meter event. Must be an integer. Can be positive or negative.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Identifier",
          "name": "identifier",
          "type": "string",
          "default": "",
          "description": "A unique identifier for the event. If not provided, one will be generated. Uniqueness is enforced within a rolling 24 hour window."
        },
        {
          "displayName": "Timestamp",
          "name": "timestamp",
          "type": "dateTime",
          "default": "",
          "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current time if not specified."
        },
        {
          "displayName": "Custom Payload Properties",
          "name": "customPayload",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Property",
          "description": "Additional custom properties to include in the event payload. Use this for custom meter configurations with non-default payload keys.",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Properties",
              "name": "properties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The property key"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The property value"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a balance",
      "resource": "balance"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add a customer card",
      "resource": "customerCard"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a customer card",
      "resource": "customerCard"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a customer card",
      "resource": "customerCard"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a charge",
      "resource": "charge"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a charge",
      "resource": "charge"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many charges",
      "resource": "charge"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a charge",
      "resource": "charge"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a coupon",
      "resource": "coupon"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many coupons",
      "resource": "coupon"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a customer",
      "resource": "customer"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a customer",
      "resource": "customer"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a customer",
      "resource": "customer"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many customers",
      "resource": "customer"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a customer",
      "resource": "customer"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a meter event",
      "resource": "meterEvent"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a source",
      "resource": "source"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a source",
      "resource": "source"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a source",
      "resource": "source"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a token",
      "resource": "token"
    }
  ]


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
credentials_required:
  [
  {
  "name": "stripeApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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": "Meter Event",
          "value": "meterEvent"
        },
        {
          "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": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a meter event",
          "action": "Create a meter event"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Event Name",
      "name": "eventName",
      "type": "string",
      "default": "",
      "description": "The name of the meter event. Corresponds with the event_name field on a meter.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "The Stripe customer ID associated with this meter event",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "number",
      "default": 1,
      "description": "The value of the meter event. Must be an integer. Can be positive or negative.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Identifier",
          "name": "identifier",
          "type": "string",
          "default": "",
          "description": "A unique identifier for the event. If not provided, one will be generated. Uniqueness is enforced within a rolling 24 hour window."
        },
        {
          "displayName": "Timestamp",
          "name": "timestamp",
          "type": "dateTime",
          "default": "",
          "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current time if not specified."
        },
        {
          "displayName": "Custom Payload Properties",
          "name": "customPayload",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Custom Property",
          "description": "Additional custom properties to include in the event payload. Use this for custom meter configurations with non-default payload keys.",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "displayName": "Properties",
              "name": "properties",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The property key"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The property value"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "meterEvent"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a balance",
      "resource": "balance"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add a customer card",
      "resource": "customerCard"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a customer card",
      "resource": "customerCard"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a customer card",
      "resource": "customerCard"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a charge",
      "resource": "charge"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a charge",
      "resource": "charge"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many charges",
      "resource": "charge"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a charge",
      "resource": "charge"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a coupon",
      "resource": "coupon"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many coupons",
      "resource": "coupon"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a customer",
      "resource": "customer"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a customer",
      "resource": "customer"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a customer",
      "resource": "customer"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many customers",
      "resource": "customer"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a customer",
      "resource": "customer"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a meter event",
      "resource": "meterEvent"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a source",
      "resource": "source"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a source",
      "resource": "source"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a source",
      "resource": "source"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a token",
      "resource": "token"
    }
  ]


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
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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 Paid",
          "value": "invoice.paid",
          "description": "Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band."
        },
        {
          "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_paid",
          "value": "invoice_payment.paid",
          "description": "Occurs when an InvoicePayment is successfully paid."
        },
        {
          "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
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "string",
      "default": "",
      "description": "The API version to use for requests. It controls the format and structure of the incoming event payloads that Stripe sends to your webhook. If empty, Stripe will use the default API version set in your account at the time, which may lead to event processing issues if the API version changes in the future."
    }
  ]


node_type: nodes-base.supabaseTool
package_name: n8n-nodes-base
display_name: Supabase Tool
description: Add, get, delete and update data in a table (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.supabase
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": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Supabase"
    },
    {
      "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": "Order By",
      "name": "orderBy",
      "type": "string",
      "default": "",
      "description": "Column(s) to order results by, e.g. <code>ID</code> or <code>created_at.desc</code>. Recommended when using Return All or Limit ≥ 1000 to avoid duplicate or missing records.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "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",
      "resource": "row"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a row",
      "resource": "row"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a row",
      "resource": "row"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many rows",
      "resource": "row"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a row",
      "resource": "row"
    }
  ]

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


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
outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
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": "Order By",
      "name": "orderBy",
      "type": "string",
      "default": "",
      "description": "Column(s) to order results by, e.g. <code>ID</code> or <code>created_at.desc</code>. Recommended when using Return All or Limit ≥ 1000 to avoid duplicate or missing records.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "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",
      "resource": "row"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a row",
      "resource": "row"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a row",
      "resource": "row"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many rows",
      "resource": "row"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a row",
      "resource": "row"
    }
  ]

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


