# nodes

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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-06 10:26:56
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SeaTable Trigger node documentation
  description: Learn how to use the SeaTable Trigger node in n8n. Follow technical documentation to integrate SeaTable Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # SeaTable Trigger node

  [SeaTable](https://seatable.io/en){:target=_blank .external-link} is a collaborative database application with a spreadsheet interface.

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

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

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "newRow",
      "options": [
        {
          "name": "New Row",
          "value": "newRow",
          "description": "Trigger on newly created rows"
        },
        {
          "name": "New or Updated Row",
          "value": "updatedRow",
          "description": "Trigger has recently created or modified rows"
        },
        {
          "name": "New Signature",
          "value": "newAsset",
          "description": "Trigger on new signatures"
        }
      ]
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "The name of SeaTable table to access. Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getTableNames"
      }
    },
    {
      "displayName": "View Name",
      "name": "viewName",
      "type": "options",
      "default": "",
      "description": "The name of SeaTable view to access. Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "event": [
            "newRow",
            "updatedRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getTableViews"
      }
    },
    {
      "displayName": "Signature Column",
      "name": "assetColumn",
      "type": "options",
      "default": "",
      "description": "Select the digital-signature column that should be tracked. Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "newAsset"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getSignatureColumns"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)",
          "displayOptions": {
            "show": {
              "/event": [
                "newRow",
                "updatedRow"
              ]
            }
          }
        }
      ]
    },
    {
      "displayName": "\"Fetch Test Event\" returns max. three items of the last hour.",
      "name": "notice",
      "type": "notice",
      "default": ""
    }
  ]


node_type: nodes-base.securityScorecardTool
package_name: n8n-nodes-base
display_name: SecurityScorecard Tool
description: Consume SecurityScorecard API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "securityScorecardApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-06 10:26:56
tool_variant_of: nodes-base.securityScorecard
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SecurityScorecard node documentation
  description: Learn how to use the SecurityScorecard node in n8n. Follow technical documentation to integrate SecurityScorecard node into your workflows.
  contentType: [integration, reference]
  ---

  # SecurityScorecard node

  Use the SecurityScorecard node to automate work in SecurityScorecard, and integrate SecurityScorecard with other applications. n8n has built-in support for a wide range of SecurityScorecard features, including creating, updating, deleting, and getting portfolio, as well as getting a company's data.

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

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

  ## Operations

  * Company
      * Get company factor scores and issue counts
      * Get company's historical factor scores
      * Get company's historical scores
      * Get company information and summary of their scorecard
      * Get company's score improvement plan
  * Industry
      * Get Factor Scores
      * Get Historical Factor Scores
      * Get Score
  * Invite
      * Create an invite for a company/user
  * Portfolio
      * Create a portfolio
      * Delete a portfolio
      * Get all portfolios
      * Update a portfolio
  * Portfolio Company
      * Add a company to portfolio
      * Get all companies in a portfolio
      * Remove a company from portfolio
  * Report
      * Download a generated report
      * Generate a report
      * Get list of recently generated report

  ## Templates and examples

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

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 SecurityScorecard"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "company",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Industry",
          "value": "industry"
        },
        {
          "name": "Invite",
          "value": "invite"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Portfolio Company",
          "value": "portfolioCompany"
        },
        {
          "name": "Report",
          "value": "report"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "description": "Get company factor scores and issue counts",
          "action": "Get a company factor scores and issue counts"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "description": "Get company's historical factor scores",
          "action": "Get a company's historical factor scores"
        },
        {
          "name": "Get Historical Scores",
          "value": "getHistoricalScore",
          "description": "Get company's historical scores",
          "action": "Get a company's historical scores"
        },
        {
          "name": "Get Information and Scorecard",
          "value": "getScorecard",
          "description": "Get company information and summary of their scorecard",
          "action": "Get company information and a summary of their scorecard"
        },
        {
          "name": "Get Score Plan",
          "value": "getScorePlan",
          "description": "Get company's score improvement plan",
          "action": "Get a company's score improvement plan"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorecard",
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Score",
      "name": "score",
      "type": "number",
      "default": 0,
      "description": "Score target",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Severity",
          "name": "severity",
          "type": "string",
          "default": "",
          "placeholder": ""
        },
        {
          "displayName": "Severity In",
          "description": "Filter issues by comma-separated severity list",
          "name": "severity_in",
          "type": "string",
          "default": "",
          "placeholder": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "date_from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "date_to",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Timing",
          "description": "Date granularity",
          "name": "timing",
          "type": "options",
          "options": [
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            }
          ],
          "default": "daily"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "action": "Get factor scores for an industry"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "action": "Get historical factor scores for an industry"
        },
        {
          "name": "Get Score",
          "value": "getScore",
          "action": "Get the score for an industry"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Industry",
      "name": "industry",
      "type": "options",
      "default": "food",
      "options": [
        {
          "name": "Food",
          "value": "food"
        },
        {
          "name": "Healthcare",
          "value": "healthcare"
        },
        {
          "name": "Manofacturing",
          "value": "manofacturing"
        },
        {
          "name": "Retail",
          "value": "retail"
        },
        {
          "name": "Technology",
          "value": "technology"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getScore",
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "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": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "to",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an invite for a company/user",
          "action": "Create an invite"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Message for the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Days to Resolve Issue",
          "description": "Minimum days to resolve a scorecard issue",
          "name": "days_to_resolve_issue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Domain",
          "description": "Invitee company domain",
          "name": "domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Grade to Maintain",
          "description": "Request the invitee's organisation to maintain a minimum grade",
          "name": "grade_to_maintain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Organisation Point of Contact",
          "description": "Is the invitee organisation's point of contact",
          "name": "is_organization_point_of_contact",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Issue Description",
          "name": "issue_desc",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Title",
          "name": "issue_title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Type",
          "name": "issue_type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Send Me a Copy",
          "name": "sendme_copy",
          "description": "Whether to send a copy of the invite to the requesting user",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Target URL",
          "name": "target_url",
          "type": "string",
          "description": "Optional URL to take the invitee to when arriving to the platform",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a portfolio",
          "action": "Create a portfolio"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a portfolio",
          "action": "Delete a portfolio"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many portfolios",
          "action": "Get many portfolios"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a portfolio",
          "action": "Update a portfolio"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "update",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the portfolio",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Description",
      "name": "description",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Privacy",
      "name": "privacy",
      "type": "options",
      "default": "shared",
      "options": [
        {
          "name": "Private",
          "value": "private",
          "description": "Only visible to you"
        },
        {
          "name": "Shared",
          "value": "shared",
          "description": "Visible to everyone in your company"
        },
        {
          "name": "Team",
          "value": "team",
          "description": "Visible to the people on your team"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a company to portfolio",
          "action": "Add a portfolio company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies in a portfolio",
          "action": "Get many portfolio companies"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a company from portfolio",
          "action": "Remove a portfolio company"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll",
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "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": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Grade",
          "name": "grade",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Company score grade filter"
        },
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Industry filter"
        },
        {
          "displayName": "Issue Type",
          "name": "issueType",
          "type": "string",
          "placeholder": "",
          "description": "Issue type filter",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Vulnerability",
          "name": "vulnerability",
          "type": "string",
          "placeholder": "",
          "description": "CVE vulnerability filter",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Company's domain name",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Download",
          "value": "download",
          "description": "Download a generated report",
          "action": "Download a report"
        },
        {
          "name": "Generate",
          "value": "generate",
          "description": "Generate a report",
          "action": "Generate a report"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get list of recently generated report",
          "action": "Get many reports"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Report",
      "name": "report",
      "type": "options",
      "default": "detailed",
      "options": [
        {
          "name": "Company Detailed",
          "value": "detailed"
        },
        {
          "name": "Company Events",
          "value": "events-json"
        },
        {
          "name": "Company Issues",
          "value": "issues"
        },
        {
          "name": "Company Partnership",
          "value": "partnership"
        },
        {
          "name": "Company Summary",
          "value": "summary"
        },
        {
          "name": "Full Scorecard",
          "value": "full-scorecard-json"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Scorecard Footprint",
          "value": "scorecard-footprint"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ]
        }
      }
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "events-json",
            "full-scorecard-json",
            "issues",
            "partnership",
            "scorecard-footprint",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Branding",
      "name": "branding",
      "type": "options",
      "default": "securityscorecard",
      "options": [
        {
          "name": "SecurityScorecard",
          "value": "securityscorecard"
        },
        {
          "name": "Company and SecurityScorecard",
          "value": "company_and_securityscorecard"
        },
        {
          "name": "Company",
          "value": "company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Date",
      "name": "date",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "events-json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "issues",
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Countries",
          "name": "countries",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        },
        {
          "displayName": "IPs",
          "name": "ips",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Subdomains",
          "name": "subdomains",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "scorecard-footprint"
          ]
        }
      }
    },
    {
      "displayName": "Report URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL to a generated report",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getFactor",
      "name": "Get Factor Scores",
      "description": "Get company factor scores and issue counts"
    },
    {
      "operation": "getFactorHistorical",
      "name": "Get Historical Factor Scores",
      "description": "Get company's historical factor scores"
    },
    {
      "operation": "getHistoricalScore",
      "name": "Get Historical Scores",
      "description": "Get company's historical scores"
    },
    {
      "operation": "getScorecard",
      "name": "Get Information and Scorecard",
      "description": "Get company information and summary of their scorecard"
    },
    {
      "operation": "getScorePlan",
      "name": "Get Score Plan",
      "description": "Get company's score improvement plan"
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-06 10:26:56
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SecurityScorecard node documentation
  description: Learn how to use the SecurityScorecard node in n8n. Follow technical documentation to integrate SecurityScorecard node into your workflows.
  contentType: [integration, reference]
  ---

  # SecurityScorecard node

  Use the SecurityScorecard node to automate work in SecurityScorecard, and integrate SecurityScorecard with other applications. n8n has built-in support for a wide range of SecurityScorecard features, including creating, updating, deleting, and getting portfolio, as well as getting a company's data.

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

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

  ## Operations

  * Company
      * Get company factor scores and issue counts
      * Get company's historical factor scores
      * Get company's historical scores
      * Get company information and summary of their scorecard
      * Get company's score improvement plan
  * Industry
      * Get Factor Scores
      * Get Historical Factor Scores
      * Get Score
  * Invite
      * Create an invite for a company/user
  * Portfolio
      * Create a portfolio
      * Delete a portfolio
      * Get all portfolios
      * Update a portfolio
  * Portfolio Company
      * Add a company to portfolio
      * Get all companies in a portfolio
      * Remove a company from portfolio
  * Report
      * Download a generated report
      * Generate a report
      * Get list of recently generated report

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "company",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Industry",
          "value": "industry"
        },
        {
          "name": "Invite",
          "value": "invite"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Portfolio Company",
          "value": "portfolioCompany"
        },
        {
          "name": "Report",
          "value": "report"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "description": "Get company factor scores and issue counts",
          "action": "Get a company factor scores and issue counts"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "description": "Get company's historical factor scores",
          "action": "Get a company's historical factor scores"
        },
        {
          "name": "Get Historical Scores",
          "value": "getHistoricalScore",
          "description": "Get company's historical scores",
          "action": "Get a company's historical scores"
        },
        {
          "name": "Get Information and Scorecard",
          "value": "getScorecard",
          "description": "Get company information and summary of their scorecard",
          "action": "Get company information and a summary of their scorecard"
        },
        {
          "name": "Get Score Plan",
          "value": "getScorePlan",
          "description": "Get company's score improvement plan",
          "action": "Get a company's score improvement plan"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorecard",
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Score",
      "name": "score",
      "type": "number",
      "default": 0,
      "description": "Score target",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Severity",
          "name": "severity",
          "type": "string",
          "default": "",
          "placeholder": ""
        },
        {
          "displayName": "Severity In",
          "description": "Filter issues by comma-separated severity list",
          "name": "severity_in",
          "type": "string",
          "default": "",
          "placeholder": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "date_from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "date_to",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Timing",
          "description": "Date granularity",
          "name": "timing",
          "type": "options",
          "options": [
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            }
          ],
          "default": "daily"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "action": "Get factor scores for an industry"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "action": "Get historical factor scores for an industry"
        },
        {
          "name": "Get Score",
          "value": "getScore",
          "action": "Get the score for an industry"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Industry",
      "name": "industry",
      "type": "options",
      "default": "food",
      "options": [
        {
          "name": "Food",
          "value": "food"
        },
        {
          "name": "Healthcare",
          "value": "healthcare"
        },
        {
          "name": "Manofacturing",
          "value": "manofacturing"
        },
        {
          "name": "Retail",
          "value": "retail"
        },
        {
          "name": "Technology",
          "value": "technology"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getScore",
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "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": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "to",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an invite for a company/user",
          "action": "Create an invite"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Message for the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Days to Resolve Issue",
          "description": "Minimum days to resolve a scorecard issue",
          "name": "days_to_resolve_issue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Domain",
          "description": "Invitee company domain",
          "name": "domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Grade to Maintain",
          "description": "Request the invitee's organisation to maintain a minimum grade",
          "name": "grade_to_maintain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Organisation Point of Contact",
          "description": "Is the invitee organisation's point of contact",
          "name": "is_organization_point_of_contact",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Issue Description",
          "name": "issue_desc",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Title",
          "name": "issue_title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Type",
          "name": "issue_type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Send Me a Copy",
          "name": "sendme_copy",
          "description": "Whether to send a copy of the invite to the requesting user",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Target URL",
          "name": "target_url",
          "type": "string",
          "description": "Optional URL to take the invitee to when arriving to the platform",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a portfolio",
          "action": "Create a portfolio"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a portfolio",
          "action": "Delete a portfolio"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many portfolios",
          "action": "Get many portfolios"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a portfolio",
          "action": "Update a portfolio"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "update",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the portfolio",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Description",
      "name": "description",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Privacy",
      "name": "privacy",
      "type": "options",
      "default": "shared",
      "options": [
        {
          "name": "Private",
          "value": "private",
          "description": "Only visible to you"
        },
        {
          "name": "Shared",
          "value": "shared",
          "description": "Visible to everyone in your company"
        },
        {
          "name": "Team",
          "value": "team",
          "description": "Visible to the people on your team"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a company to portfolio",
          "action": "Add a portfolio company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies in a portfolio",
          "action": "Get many portfolio companies"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a company from portfolio",
          "action": "Remove a portfolio company"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll",
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "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": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Grade",
          "name": "grade",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Company score grade filter"
        },
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Industry filter"
        },
        {
          "displayName": "Issue Type",
          "name": "issueType",
          "type": "string",
          "placeholder": "",
          "description": "Issue type filter",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Vulnerability",
          "name": "vulnerability",
          "type": "string",
          "placeholder": "",
          "description": "CVE vulnerability filter",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Company's domain name",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Download",
          "value": "download",
          "description": "Download a generated report",
          "action": "Download a report"
        },
        {
          "name": "Generate",
          "value": "generate",
          "description": "Generate a report",
          "action": "Generate a report"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get list of recently generated report",
          "action": "Get many reports"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Report",
      "name": "report",
      "type": "options",
      "default": "detailed",
      "options": [
        {
          "name": "Company Detailed",
          "value": "detailed"
        },
        {
          "name": "Company Events",
          "value": "events-json"
        },
        {
          "name": "Company Issues",
          "value": "issues"
        },
        {
          "name": "Company Partnership",
          "value": "partnership"
        },
        {
          "name": "Company Summary",
          "value": "summary"
        },
        {
          "name": "Full Scorecard",
          "value": "full-scorecard-json"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Scorecard Footprint",
          "value": "scorecard-footprint"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ]
        }
      }
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "events-json",
            "full-scorecard-json",
            "issues",
            "partnership",
            "scorecard-footprint",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Branding",
      "name": "branding",
      "type": "options",
      "default": "securityscorecard",
      "options": [
        {
          "name": "SecurityScorecard",
          "value": "securityscorecard"
        },
        {
          "name": "Company and SecurityScorecard",
          "value": "company_and_securityscorecard"
        },
        {
          "name": "Company",
          "value": "company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Date",
      "name": "date",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "events-json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "issues",
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Countries",
          "name": "countries",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        },
        {
          "displayName": "IPs",
          "name": "ips",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Subdomains",
          "name": "subdomains",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "scorecard-footprint"
          ]
        }
      }
    },
    {
      "displayName": "Report URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL to a generated report",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getFactor",
      "name": "Get Factor Scores",
      "description": "Get company factor scores and issue counts"
    },
    {
      "operation": "getFactorHistorical",
      "name": "Get Historical Factor Scores",
      "description": "Get company's historical factor scores"
    },
    {
      "operation": "getHistoricalScore",
      "name": "Get Historical Scores",
      "description": "Get company's historical scores"
    },
    {
      "operation": "getScorecard",
      "name": "Get Information and Scorecard",
      "description": "Get company information and summary of their scorecard"
    },
    {
      "operation": "getScorePlan",
      "name": "Get Score Plan",
      "description": "Get company's score improvement plan"
    }
  ]


node_type: nodes-base.segmentTool
package_name: n8n-nodes-base
display_name: Segment Tool
description: Consume Segment API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "add",
  "name": "Add",
  "description": "Add a user to a group"
  }
  ]

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

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-06 10:26:56
tool_variant_of: nodes-base.segment
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Segment node documentation
  description: Learn how to use the Segment node in n8n. Follow technical documentation to integrate Segment node into your workflows.
  contentType: [integration, reference]
  ---

  # Segment node

  Use the Segment node to automate work in Segment, and integrate Segment with other applications. n8n has built-in support for a wide range of Segment features, including adding users to groups, creating identities, and tracking activities. 

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

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

  ## Operations

  * Group
      * Add a user to a group
  * Identify
      * Create an identity
  * Track
      * Record the actions your users perform. Every action triggers an event, which can also have associated properties.
      * Record page views on your website, along with optional extra information about the page being viewed.

  ## Templates and examples

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

  --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 Segment"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "identify",
      "options": [
        {
          "name": "Group",
          "value": "group",
          "description": "Group lets you associate an identified user with a group"
        },
        {
          "name": "Identify",
          "value": "identify",
          "description": "Identify lets you tie a user to their actions"
        },
        {
          "name": "Track",
          "value": "track",
          "description": "Track lets you record events"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a user to a group",
          "action": "Add a user to a group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "A Group ID is the unique identifier which you recognize a group by in your own database",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an identity",
          "action": "Create an identity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "event",
      "options": [
        {
          "name": "Event",
          "value": "event",
          "description": "Record the actions your users perform. Every action triggers an event, which can also have associated properties.",
          "action": "Track an event"
        },
        {
          "name": "Page",
          "value": "page",
          "description": "Record page views on your website, along with optional extra information about the page being viewed",
          "action": "Track a page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "string",
      "default": "",
      "description": "Name of the action that a user has performed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]


node_type: nodes-base.segment
package_name: n8n-nodes-base
display_name: Segment
description: Consume Segment API
category: output
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "add",
  "name": "Add",
  "description": "Add a user to a group"
  }
  ]

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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-06 10:26:56
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Segment node documentation
  description: Learn how to use the Segment node in n8n. Follow technical documentation to integrate Segment node into your workflows.
  contentType: [integration, reference]
  ---

  # Segment node

  Use the Segment node to automate work in Segment, and integrate Segment with other applications. n8n has built-in support for a wide range of Segment features, including adding users to groups, creating identities, and tracking activities. 

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

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

  ## Operations

  * Group
      * Add a user to a group
  * Identify
      * Create an identity
  * Track
      * Record the actions your users perform. Every action triggers an event, which can also have associated properties.
      * Record page views on your website, along with optional extra information about the page being viewed.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "identify",
      "options": [
        {
          "name": "Group",
          "value": "group",
          "description": "Group lets you associate an identified user with a group"
        },
        {
          "name": "Identify",
          "value": "identify",
          "description": "Identify lets you tie a user to their actions"
        },
        {
          "name": "Track",
          "value": "track",
          "description": "Track lets you record events"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a user to a group",
          "action": "Add a user to a group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "A Group ID is the unique identifier which you recognize a group by in your own database",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an identity",
          "action": "Create an identity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "event",
      "options": [
        {
          "name": "Event",
          "value": "event",
          "description": "Record the actions your users perform. Every action triggers an event, which can also have associated properties.",
          "action": "Track an event"
        },
        {
          "name": "Page",
          "value": "page",
          "description": "Record page views on your website, along with optional extra information about the page being viewed",
          "action": "Track a page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "string",
      "default": "",
      "description": "Name of the action that a user has performed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]


node_type: nodes-base.sendGridTool
package_name: n8n-nodes-base
display_name: SendGrid Tool
description: Consume SendGrid API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "sendGridApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-06 10:26:56
tool_variant_of: nodes-base.sendGrid
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SendGrid node documentation
  description: Learn how to use the SendGrid node in n8n. Follow technical documentation to integrate SendGrid node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # SendGrid node

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

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

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

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

  ## Operations

  * Contact
      * Create/update a contact
      * Delete a contact
      * Get a contact by ID
      * Get all contacts
  * List
      * Create a list
      * Delete a list
      * Get a list
      * Get all lists
      * Update a list
  * Mail
      * Send an email.

  ## Templates and examples

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

  --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 SendGrid"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "List",
          "value": "list"
        },
        {
          "name": "Mail",
          "value": "mail"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a list",
          "action": "Delete a list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a list",
          "action": "Get a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many lists",
          "action": "Get many lists"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a list",
          "action": "Update a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Delete Contacts",
      "name": "deleteContacts",
      "type": "boolean",
      "default": false,
      "description": "Whether to delete all contacts on the list",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Contact Sample",
      "name": "contactSample",
      "type": "boolean",
      "default": false,
      "description": "Whether to return the contact sample",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new contact, or update the current one if it already exists (upsert)",
          "action": "Create or update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact by ID",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "The query field accepts valid <a href=\"https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/\">SGQL</a> for searching for a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Primary email for the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Alternate Emails",
          "name": "alternateEmails",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "State/Province/Region",
          "name": "stateProvinceRegion",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "List IDs",
          "name": "listIdsUi",
          "placeholder": "List IDs",
          "description": "Adds a custom field to set also values which have not been predefined",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "listIdValues",
              "displayName": "List IDs",
              "values": [
                {
                  "displayName": "List Names or IDs",
                  "name": "listIds",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getListIds"
                  },
                  "default": [],
                  "description": "ID of the field to set. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                }
              ]
            }
          ]
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds custom fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value for the field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Contact IDs",
      "name": "ids",
      "type": "string",
      "default": "",
      "description": "ID of the contact. Multiple can be added separated by comma.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ],
          "deleteAll": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Delete All",
      "name": "deleteAll",
      "type": "boolean",
      "default": false,
      "description": "Whether all contacts will be deleted",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "id",
      "description": "Search the user by ID or email",
      "options": [
        {
          "name": "ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send an email",
          "action": "Send an email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sender Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Sender Name",
      "name": "fromName",
      "type": "string",
      "default": "",
      "description": "Name of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Recipient Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of recipient email addresses",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject of the email to send",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Dynamic Template",
      "name": "dynamicTemplate",
      "type": "boolean",
      "default": false,
      "description": "Whether this email will contain a dynamic template",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "MIME Type",
      "name": "contentType",
      "type": "options",
      "default": "text/plain",
      "description": "MIME type of the email to send",
      "options": [
        {
          "name": "Plain Text",
          "value": "text/plain"
        },
        {
          "name": "HTML",
          "value": "text/html"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Message Body",
      "name": "contentValue",
      "type": "string",
      "default": "",
      "description": "Message body of the email to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "type": "options",
      "default": [],
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplateIds"
      }
    },
    {
      "displayName": "Dynamic Template Fields",
      "name": "dynamicTemplateFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Key of the dynamic template field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value for the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attachments",
          "name": "attachments",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of binary properties"
        },
        {
          "displayName": "BCC Email",
          "name": "bccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a blind carbon copy of the email"
        },
        {
          "displayName": "Categories",
          "name": "categories",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of categories. Each category name may not exceed 255 characters."
        },
        {
          "displayName": "CC Email",
          "name": "ccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a carbon copy of the email"
        },
        {
          "displayName": "Enable Sandbox",
          "name": "enableSandbox",
          "type": "boolean",
          "default": false,
          "description": "Whether to use to the sandbox for testing out email-sending functionality"
        },
        {
          "displayName": "IP Pool Name",
          "name": "ipPoolName",
          "type": "string",
          "default": "",
          "description": "The IP Pool that you would like to send this email from"
        },
        {
          "displayName": "Reply-To Email",
          "name": "replyToEmail",
          "type": "string",
          "default": "",
          "placeholder": "reply@domain.com",
          "description": "Comma-separated list of email addresses that will appear in the reply-to field of the email"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "Key to set in the header object"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set in the header object"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Send At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "description": "When to deliver the email. Scheduling more than 72 hours in advance is forbidden."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-06 10:26:56
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: SendGrid node documentation
  description: Learn how to use the SendGrid node in n8n. Follow technical documentation to integrate SendGrid node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # SendGrid node

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

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

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

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

  ## Operations

  * Contact
      * Create/update a contact
      * Delete a contact
      * Get a contact by ID
      * Get all contacts
  * List
      * Create a list
      * Delete a list
      * Get a list
      * Get all lists
      * Update a list
  * Mail
      * Send an email.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "List",
          "value": "list"
        },
        {
          "name": "Mail",
          "value": "mail"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a list",
          "action": "Delete a list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a list",
          "action": "Get a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many lists",
          "action": "Get many lists"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a list",
          "action": "Update a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Delete Contacts",
      "name": "deleteContacts",
      "type": "boolean",
      "default": false,
      "description": "Whether to delete all contacts on the list",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Contact Sample",
      "name": "contactSample",
      "type": "boolean",
      "default": false,
      "description": "Whether to return the contact sample",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new contact, or update the current one if it already exists (upsert)",
          "action": "Create or update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact by ID",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "The query field accepts valid <a href=\"https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/\">SGQL</a> for searching for a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Primary email for the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Alternate Emails",
          "name": "alternateEmails",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "State/Province/Region",
          "name": "stateProvinceRegion",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "List IDs",
          "name": "listIdsUi",
          "placeholder": "List IDs",
          "description": "Adds a custom field to set also values which have not been predefined",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "listIdValues",
              "displayName": "List IDs",
              "values": [
                {
                  "displayName": "List Names or IDs",
                  "name": "listIds",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getListIds"
                  },
                  "default": [],
                  "description": "ID of the field to set. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                }
              ]
            }
          ]
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds custom fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value for the field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Contact IDs",
      "name": "ids",
      "type": "string",
      "default": "",
      "description": "ID of the contact. Multiple can be added separated by comma.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ],
          "deleteAll": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Delete All",
      "name": "deleteAll",
      "type": "boolean",
      "default": false,
      "description": "Whether all contacts will be deleted",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "id",
      "description": "Search the user by ID or email",
      "options": [
        {
          "name": "ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send an email",
          "action": "Send an email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sender Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Sender Name",
      "name": "fromName",
      "type": "string",
      "default": "",
      "description": "Name of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Recipient Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of recipient email addresses",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject of the email to send",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Dynamic Template",
      "name": "dynamicTemplate",
      "type": "boolean",
      "default": false,
      "description": "Whether this email will contain a dynamic template",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "MIME Type",
      "name": "contentType",
      "type": "options",
      "default": "text/plain",
      "description": "MIME type of the email to send",
      "options": [
        {
          "name": "Plain Text",
          "value": "text/plain"
        },
        {
          "name": "HTML",
          "value": "text/html"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Message Body",
      "name": "contentValue",
      "type": "string",
      "default": "",
      "description": "Message body of the email to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "type": "options",
      "default": [],
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplateIds"
      }
    },
    {
      "displayName": "Dynamic Template Fields",
      "name": "dynamicTemplateFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Key of the dynamic template field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value for the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attachments",
          "name": "attachments",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of binary properties"
        },
        {
          "displayName": "BCC Email",
          "name": "bccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a blind carbon copy of the email"
        },
        {
          "displayName": "Categories",
          "name": "categories",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of categories. Each category name may not exceed 255 characters."
        },
        {
          "displayName": "CC Email",
          "name": "ccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a carbon copy of the email"
        },
        {
          "displayName": "Enable Sandbox",
          "name": "enableSandbox",
          "type": "boolean",
          "default": false,
          "description": "Whether to use to the sandbox for testing out email-sending functionality"
        },
        {
          "displayName": "IP Pool Name",
          "name": "ipPoolName",
          "type": "string",
          "default": "",
          "description": "The IP Pool that you would like to send this email from"
        },
        {
          "displayName": "Reply-To Email",
          "name": "replyToEmail",
          "type": "string",
          "default": "",
          "placeholder": "reply@domain.com",
          "description": "Comma-separated list of email addresses that will appear in the reply-to field of the email"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "Key to set in the header object"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set in the header object"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Send At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "description": "When to deliver the email. Scheduling more than 72 hours in advance is forbidden."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

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


node_type: nodes-base.sendyTool
package_name: n8n-nodes-base
display_name: Sendy Tool
description: Consume Sendy API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "create",
  "name": "Create",
  "description": "Create a campaign"
  }
  ]

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

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-01-06 10:26:56
tool_variant_of: nodes-base.sendy
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Sendy node documentation
  description: Learn how to use the Sendy node in n8n. Follow technical documentation to integrate Sendy node into your workflows.
  contentType: [integration, reference]
  ---

  # Sendy node

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

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

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

  ## Operations

  * Campaign
      * Create a campaign
  * Subscriber
      * Add a subscriber to a list
      * Count subscribers
      * Delete a subscriber from a list
      * Unsubscribe user from a list
      * Get the status of subscriber

  ## Templates and examples

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

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 Sendy"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "subscriber",
      "options": [
        {
          "name": "Campaign",
          "value": "campaign"
        },
        {
          "name": "Subscriber",
          "value": "subscriber"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a campaign",
          "action": "Create a campaign"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From Name",
      "name": "fromName",
      "type": "string",
      "default": "",
      "description": "The 'From name' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The 'From email' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Reply To",
      "name": "replyTo",
      "type": "string",
      "default": "",
      "description": "The 'Reply to' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "The 'Title' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "The 'Subject' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "HTML Text",
      "name": "htmlText",
      "type": "string",
      "default": "",
      "description": "The 'HTML version' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Send Campaign",
      "name": "sendCampaign",
      "type": "boolean",
      "default": false,
      "description": "Whether to send the campaign as well and not just create a draft. Default is false.",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Brand ID",
      "name": "brandId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "campaign"
          ],
          "sendCampaign": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude List IDs",
          "name": "excludeListIds",
          "type": "string",
          "default": "",
          "description": "Lists to exclude from your campaign. List IDs should be single or comma-separated."
        },
        {
          "displayName": "Exclude Segment IDs",
          "name": "excludeSegmentIds",
          "type": "string",
          "default": "",
          "description": "Segments to exclude from your campaign. Segment IDs should be single or comma-separated."
        },
        {
          "displayName": "List IDs",
          "name": "listIds",
          "type": "string",
          "default": "",
          "description": "List IDs should be single or comma-separated"
        },
        {
          "displayName": "Plain Text",
          "name": "plainText",
          "type": "string",
          "default": "",
          "description": "The 'Plain text version' of your campaign"
        },
        {
          "displayName": "Querystring",
          "name": "queryString",
          "type": "string",
          "default": "",
          "description": "Google Analytics tags"
        },
        {
          "displayName": "Segment IDs",
          "name": "segmentIds",
          "type": "string",
          "default": "",
          "description": "Segment IDs should be single or comma-separated"
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "boolean",
          "default": true,
          "description": "Whether to disable clicks tracking. Default is true."
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "boolean",
          "default": true,
          "description": "Whether to disable opens tracking. Default is true."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a subscriber to a list",
          "action": "Add a subscriber"
        },
        {
          "name": "Count",
          "value": "count",
          "description": "Count subscribers",
          "action": "Count a subscriber"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a subscriber from a list",
          "action": "Delete a subscriber"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Unsubscribe user from a list",
          "action": "Remove a subscriber"
        },
        {
          "name": "Status",
          "value": "status",
          "description": "Get the status of subscriber",
          "action": "Get subscriber's status"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": "",
          "description": "User's 2 letter country code"
        },
        {
          "displayName": "GDPR",
          "name": "gdpr",
          "type": "boolean",
          "default": false,
          "description": "Whether you're signing up EU users in a GDPR compliant manner"
        },
        {
          "displayName": "Honeypot",
          "name": "hp",
          "type": "boolean",
          "default": false,
          "description": "Include this 'honeypot' field to prevent spambots from signing up via this API call. When spambots fills in this field, this API call will exit, preventing them from signing up fake addresses to your form. This parameter is only supported in Sendy 3.0 onwards."
        },
        {
          "displayName": "IP Address",
          "name": "ipaddress",
          "type": "string",
          "default": "",
          "description": "User's IP address"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "User's name"
        },
        {
          "displayName": "Referrer",
          "name": "referrer",
          "type": "string",
          "default": "",
          "description": "The URL where the user signed up from"
        },
        {
          "displayName": "Silent",
          "name": "silent",
          "type": "boolean",
          "default": false,
          "description": "Set to \"true\" if your list is 'Double opt-in' but you want to bypass that and signup the user to the list as 'Single Opt-in instead' (optional)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "count"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "status"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "status"
          ]
        }
      }
    }
  ]


node_type: nodes-base.sendy
package_name: n8n-nodes-base
display_name: Sendy
description: Consume Sendy API
category: input
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "create",
  "name": "Create",
  "description": "Create a campaign"
  }
  ]

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

outputs:
  [
  "main"
  ]

updated_at: 2026-01-06 10:26:56
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Sendy node documentation
  description: Learn how to use the Sendy node in n8n. Follow technical documentation to integrate Sendy node into your workflows.
  contentType: [integration, reference]
  ---

  # Sendy node

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

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

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

  ## Operations

  * Campaign
      * Create a campaign
  * Subscriber
      * Add a subscriber to a list
      * Count subscribers
      * Delete a subscriber from a list
      * Unsubscribe user from a list
      * Get the status of subscriber

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "subscriber",
      "options": [
        {
          "name": "Campaign",
          "value": "campaign"
        },
        {
          "name": "Subscriber",
          "value": "subscriber"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a campaign",
          "action": "Create a campaign"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From Name",
      "name": "fromName",
      "type": "string",
      "default": "",
      "description": "The 'From name' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The 'From email' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Reply To",
      "name": "replyTo",
      "type": "string",
      "default": "",
      "description": "The 'Reply to' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "The 'Title' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "The 'Subject' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "HTML Text",
      "name": "htmlText",
      "type": "string",
      "default": "",
      "description": "The 'HTML version' of your campaign",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Send Campaign",
      "name": "sendCampaign",
      "type": "boolean",
      "default": false,
      "description": "Whether to send the campaign as well and not just create a draft. Default is false.",
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Brand ID",
      "name": "brandId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "campaign"
          ],
          "sendCampaign": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude List IDs",
          "name": "excludeListIds",
          "type": "string",
          "default": "",
          "description": "Lists to exclude from your campaign. List IDs should be single or comma-separated."
        },
        {
          "displayName": "Exclude Segment IDs",
          "name": "excludeSegmentIds",
          "type": "string",
          "default": "",
          "description": "Segments to exclude from your campaign. Segment IDs should be single or comma-separated."
        },
        {
          "displayName": "List IDs",
          "name": "listIds",
          "type": "string",
          "default": "",
          "description": "List IDs should be single or comma-separated"
        },
        {
          "displayName": "Plain Text",
          "name": "plainText",
          "type": "string",
          "default": "",
          "description": "The 'Plain text version' of your campaign"
        },
        {
          "displayName": "Querystring",
          "name": "queryString",
          "type": "string",
          "default": "",
          "description": "Google Analytics tags"
        },
        {
          "displayName": "Segment IDs",
          "name": "segmentIds",
          "type": "string",
          "default": "",
          "description": "Segment IDs should be single or comma-separated"
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "boolean",
          "default": true,
          "description": "Whether to disable clicks tracking. Default is true."
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "boolean",
          "default": true,
          "description": "Whether to disable opens tracking. Default is true."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaign"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a subscriber to a list",
          "action": "Add a subscriber"
        },
        {
          "name": "Count",
          "value": "count",
          "description": "Count subscribers",
          "action": "Count a subscriber"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a subscriber from a list",
          "action": "Delete a subscriber"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Unsubscribe user from a list",
          "action": "Remove a subscriber"
        },
        {
          "name": "Status",
          "value": "status",
          "description": "Get the status of subscriber",
          "action": "Get subscriber's status"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": "",
          "description": "User's 2 letter country code"
        },
        {
          "displayName": "GDPR",
          "name": "gdpr",
          "type": "boolean",
          "default": false,
          "description": "Whether you're signing up EU users in a GDPR compliant manner"
        },
        {
          "displayName": "Honeypot",
          "name": "hp",
          "type": "boolean",
          "default": false,
          "description": "Include this 'honeypot' field to prevent spambots from signing up via this API call. When spambots fills in this field, this API call will exit, preventing them from signing up fake addresses to your form. This parameter is only supported in Sendy 3.0 onwards."
        },
        {
          "displayName": "IP Address",
          "name": "ipaddress",
          "type": "string",
          "default": "",
          "description": "User's IP address"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "User's name"
        },
        {
          "displayName": "Referrer",
          "name": "referrer",
          "type": "string",
          "default": "",
          "description": "The URL where the user signed up from"
        },
        {
          "displayName": "Silent",
          "name": "silent",
          "type": "boolean",
          "default": false,
          "description": "Set to \"true\" if your list is 'Double opt-in' but you want to bypass that and signup the user to the list as 'Single Opt-in instead' (optional)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "count"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the subscriber",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "status"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "status"
          ]
        }
      }
    }
  ]


node_type: nodes-base.sentryIoTool
package_name: n8n-nodes-base
display_name: Sentry.io Tool
description: Consume Sentry.io 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-01-06 10:26:56
tool_variant_of: nodes-base.sentryIo
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Sentry.io node documentation
  description: Learn how to use the Sentry.io node in n8n. Follow technical documentation to integrate Sentry.io node into your workflows.
  contentType: [integration, reference]
  ---

  # Sentry.io node

  Use the Sentry.io node to automate work in Sentry.io, and integrate Sentry.io with other applications. n8n has built-in support for a wide range of Sentry.io features, including creating, updating, deleting, and getting, issues, projects, and releases, as well as getting all events.

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

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

  ## Operations

  * Event
      * Get event by ID
      * Get all events
  * Issue
      * Delete an issue
      * Get issue by ID
      * Get all issues
      * Update an issue
  * Project
      * Create a new project
      * Delete a project
      * Get project by ID
      * Get all projects
      * Update a project
  * Release
      * Create a release
      * Delete a release
      * Get release by version identifier
      * Get all releases
      * Update a release
  * Organization
      * Create an organization
      * Get organization by slug
      * Get all organizations
      * Update an organization
  * Team
      * Create a new team
      * Delete a team
      * Get team by slug
      * Get all teams
      * Update a team

  ## Templates and examples

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

  ## Related resources

  Refer to [Sentry.io's documentation](https://docs.sentry.io/api/){: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 interact with Sentry.io"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token (Cloud)",
          "value": "accessToken"
        },
        {
          "name": "OAuth2 (Cloud)",
          "value": "oAuth2"
        },
        {
          "name": "Access Token (Self Hosted)",
          "value": "accessTokenServer"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "event",
      "options": [
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Issue",
          "value": "issue"
        },
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Project",
          "value": "project"
        },
        {
          "name": "Release",
          "value": "release"
        },
        {
          "name": "Team",
          "value": "team"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get event by ID",
          "action": "Get an event"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many events",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the events belong to. 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": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project the events belong to. 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": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Full",
      "name": "full",
      "type": "boolean",
      "default": true,
      "description": "Whether the event payload will include the full event body, including the stack trace",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "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": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the events belong to. 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": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project the events belong to. 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": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "The ID of the event to retrieve (either the numeric primary-key or the hexadecimal ID as reported by the raven client)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an issue",
          "action": "Delete an issue"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get issue by ID",
          "action": "Get an issue"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many issues",
          "action": "Get many issues"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an issue",
          "action": "Update an issue"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of issue to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the issues belong to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project the issues belong to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "issue"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "issue"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "An optional Sentry structured search query. If not provided, an implied \"is:unresolved\" is assumed. Info <a href=\"https://docs.sentry.io/product/sentry-basics/search/\">here</a>."
        },
        {
          "displayName": "Stats Period",
          "name": "statsPeriod",
          "type": "options",
          "default": "",
          "description": "Time period of stats",
          "options": [
            {
              "name": "14 Days",
              "value": "14d"
            },
            {
              "name": "24 Hours",
              "value": "24h"
            }
          ]
        },
        {
          "displayName": "Short ID Lookup",
          "name": "shortIdLookUp",
          "type": "boolean",
          "default": true,
          "description": "Whether short IDs are looked up by this function as well. This can cause the return value of the function to return an event issue of a different project which is why this is an opt-in."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of issue to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "string",
          "default": "",
          "description": "The actor ID (or username) of the user or team that should be assigned to this issue"
        },
        {
          "displayName": "Has Seen",
          "name": "hasSeen",
          "type": "boolean",
          "default": true,
          "description": "Whether this API call is invoked with a user context this allows changing of the flag that indicates if the user has seen the event"
        },
        {
          "displayName": "Is Bookmarked",
          "name": "isBookmarked",
          "type": "boolean",
          "default": true,
          "description": "Whether this API call is invoked with a user context this allows changing of the bookmark flag"
        },
        {
          "displayName": "Is Public",
          "name": "isPublic",
          "type": "boolean",
          "default": true,
          "description": "Whether to set the issue to public or private"
        },
        {
          "displayName": "Is Subscribed",
          "name": "isSubscribed",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "",
          "description": "The new status for the issue",
          "options": [
            {
              "name": "Ignored",
              "value": "ignored"
            },
            {
              "name": "Resolved",
              "value": "resolved"
            },
            {
              "name": "Resolved Next Release",
              "value": "resolvedInNextRelease"
            },
            {
              "name": "Unresolved",
              "value": "unresolved"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an organization",
          "action": "Create an organization"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get organization by slug",
          "action": "Get an organization"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many organizations",
          "action": "Get many organizations"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an organization",
          "action": "Update an organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "organization"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Member",
          "name": "member",
          "type": "boolean",
          "default": true,
          "description": "Whether to restrict results to organizations which you have membership"
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "boolean",
          "default": true,
          "description": "Whether to restrict results to organizations which you are the owner"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team should be created for. 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": [
            "organization"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The slug of the organization the team should be created for",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Agree to Terms",
      "name": "agreeTerms",
      "type": "boolean",
      "default": false,
      "description": "Whether you agree to the applicable terms of service and privacy policy of Sentry.io",
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The unique URL slug for this organization. If this is not provided a slug is automatically generated based on the name."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Slug Name or ID",
      "name": "organization_slug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization to update. 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": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The new name of the organization"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The new URL slug for this organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new project",
          "action": "Create a project"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a project",
          "action": "Delete a project"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get project by ID",
          "action": "Get a project"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many projects",
          "action": "Get many projects"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a project",
          "action": "Update a project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the events belong to. 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": [
            "project"
          ],
          "operation": [
            "create",
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project to retrieve. 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": [
            "project"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to create a new project for. 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": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name for the new project",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "Optionally a slug for the new project. If it’s not provided a slug is generated from the name."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the project belong to. 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": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project to update. 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": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bookmarked",
          "name": "isBookmarked",
          "type": "boolean",
          "default": false,
          "description": "The new platform for the updated project"
        },
        {
          "displayName": "Digests Maximum Delay",
          "name": "digestsMaxDelay",
          "type": "number",
          "default": 1800,
          "description": "Maximum interval to digest alerts"
        },
        {
          "displayName": "Digests Minimun Delay",
          "name": "digestsMinDelay",
          "type": "number",
          "default": 60,
          "description": "Minium interval to digest alerts"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The new name for the updated project"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The new slug for the updated project"
        },
        {
          "displayName": "Team",
          "name": "team",
          "type": "string",
          "default": "",
          "description": "The new team name"
        },
        {
          "displayName": "Platform",
          "name": "platform",
          "type": "string",
          "default": "",
          "description": "The new platform for the updated project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the project belong to. 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": [
            "project"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project to delete. 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": [
            "project"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a release",
          "action": "Create a release"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a release",
          "action": "Delete a release"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get release by version identifier",
          "action": "Get a release by version ID"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many releases",
          "action": "Get many releases"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a release",
          "action": "Update a release"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the releases belong to. 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": [
            "release"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "release"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "release"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "This parameter can be used to create a “starts with” filter for the version"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the release belongs to. 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": [
            "release"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Version",
      "name": "version",
      "type": "string",
      "default": "",
      "description": "The version identifier of the release",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the release belongs to. 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": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Version",
      "name": "version",
      "type": "string",
      "default": "",
      "description": "A version identifier for this release. Can be a version number, a commit hash etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "A URL that points to the release. This can be the path to an online interface to the sourcecode for instance.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Project Names or IDs",
      "name": "projects",
      "type": "multiOptions",
      "default": [],
      "description": "A list of project slugs that are involved in this release. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date Released",
          "name": "dateReleased",
          "type": "dateTime",
          "default": "",
          "description": "An optional date that indicates when the release went live. If not provided the current time is assumed."
        },
        {
          "displayName": "Commits",
          "name": "commits",
          "description": "An optional list of commit data to be associated with the release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "commitProperties",
              "displayName": "Commit Properties",
              "values": [
                {
                  "displayName": "ID",
                  "name": "id",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Author Email",
                  "name": "authorEmail",
                  "type": "string",
                  "default": "",
                  "description": "Authors email"
                },
                {
                  "displayName": "Author Name",
                  "name": "authorName",
                  "type": "string",
                  "default": "",
                  "description": "Name of author"
                },
                {
                  "displayName": "Message",
                  "name": "message",
                  "type": "string",
                  "default": "",
                  "description": "Message of commit"
                },
                {
                  "displayName": "Patch Set",
                  "name": "patchSet",
                  "description": "A list of the files that have been changed in the commit. Specifying the patch_set is necessary to power suspect commits and suggested assignees.",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": true
                  },
                  "default": {},
                  "options": [
                    {
                      "name": "patchSetProperties",
                      "displayName": "Patch Set Properties",
                      "values": [
                        {
                          "displayName": "Path",
                          "name": "path",
                          "type": "string",
                          "default": "",
                          "description": "The path to the file. Both forward and backward slashes are supported.",
                          "required": true
                        },
                        {
                          "displayName": "Type",
                          "name": "type",
                          "type": "options",
                          "default": "",
                          "description": "The types of changes that happened in that commit",
                          "options": [
                            {
                              "name": "Add",
                              "value": "add"
                            },
                            {
                              "name": "Modify",
                              "value": "modify"
                            },
                            {
                              "name": "Delete",
                              "value": "delete"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name"
                },
                {
                  "displayName": "Timestamp",
                  "name": "timestamp",
                  "type": "dateTime",
                  "default": "",
                  "description": "Timestamp of commit"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Refs",
          "name": "refs",
          "description": "An optional way to indicate the start and end commits for each repository included in a release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "refProperties",
              "displayName": "Ref Properties",
              "values": [
                {
                  "displayName": "Commit",
                  "name": "commit",
                  "type": "string",
                  "default": "",
                  "description": "The head sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name",
                  "required": true
                },
                {
                  "displayName": "Previous Commit",
                  "name": "previousCommit",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the HEAD of the previous release"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the release belongs to. 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": [
            "release"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Version",
      "name": "version",
      "type": "string",
      "default": "",
      "description": "A version identifier for this release. Can be a version number, a commit hash etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Commits",
          "name": "commits",
          "description": "An optional list of commit data to be associated with the release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "commitProperties",
              "displayName": "Commit Properties",
              "values": [
                {
                  "displayName": "ID",
                  "name": "id",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Author Email",
                  "name": "authorEmail",
                  "type": "string",
                  "default": "",
                  "description": "Authors email"
                },
                {
                  "displayName": "Author Name",
                  "name": "authorName",
                  "type": "string",
                  "default": "",
                  "description": "Name of author"
                },
                {
                  "displayName": "Message",
                  "name": "message",
                  "type": "string",
                  "default": "",
                  "description": "Message of commit"
                },
                {
                  "displayName": "Patch Set",
                  "name": "patchSet",
                  "description": "A list of the files that have been changed in the commit. Specifying the patch_set is necessary to power suspect commits and suggested assignees.",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": true
                  },
                  "default": {},
                  "options": [
                    {
                      "name": "patchSetProperties",
                      "displayName": "Patch Set Properties",
                      "values": [
                        {
                          "displayName": "Path",
                          "name": "path",
                          "type": "string",
                          "default": "",
                          "description": "The path to the file. Both forward and backward slashes are supported.",
                          "required": true
                        },
                        {
                          "displayName": "Type",
                          "name": "type",
                          "type": "options",
                          "default": "",
                          "description": "The types of changes that happened in that commit",
                          "options": [
                            {
                              "name": "Add",
                              "value": "add"
                            },
                            {
                              "name": "Modify",
                              "value": "modify"
                            },
                            {
                              "name": "Delete",
                              "value": "delete"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name"
                },
                {
                  "displayName": "Timestamp",
                  "name": "timestamp",
                  "type": "dateTime",
                  "default": "",
                  "description": "Timestamp of commit"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date Released",
          "name": "dateReleased",
          "type": "dateTime",
          "default": "",
          "description": "An optional date that indicates when the release went live. If not provided the current time is assumed."
        },
        {
          "displayName": "Ref",
          "name": "ref",
          "type": "string",
          "default": "",
          "description": "A URL that points to the release. This can be the path to an online interface to the sourcecode for instance."
        },
        {
          "displayName": "Refs",
          "name": "refs",
          "description": "An optional way to indicate the start and end commits for each repository included in a release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "refProperties",
              "displayName": "Ref Properties",
              "values": [
                {
                  "displayName": "Commit",
                  "name": "commit",
                  "type": "string",
                  "default": "",
                  "description": "The head sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name",
                  "required": true
                },
                {
                  "displayName": "Previous Commit",
                  "name": "previousCommit",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the HEAD of the previous release"
                }
              ]
            }
          ]
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "A URL that points to the release. This can be the path to an online interface to the sourcecode for instance."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new team",
          "action": "Create a team"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a team",
          "action": "Delete a team"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get team by slug",
          "action": "Get a team"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many teams",
          "action": "Get many teams"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a team",
          "action": "Update a team"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization for which the teams should be listed. 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": [
            "team"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "team"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "team"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to get. 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": [
            "team"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the team",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The optional slug for this team. If not provided it will be auto generated from the name."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to update. 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": [
            "team"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The new name of the team"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The new slug of the team. Must be unique and available."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to delete. 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": [
            "team"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get event by ID"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many events"
    }
  ]

credentials_required:
  [
    {
      "name": "sentryIoOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    },
    {
      "name": "sentryIoApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "sentryIoServerApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessTokenServer"
          ]
        }
      }
    }
  ]


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

updated_at: 2026-01-06 10:26:56
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Sentry.io node documentation
  description: Learn how to use the Sentry.io node in n8n. Follow technical documentation to integrate Sentry.io node into your workflows.
  contentType: [integration, reference]
  ---

  # Sentry.io node

  Use the Sentry.io node to automate work in Sentry.io, and integrate Sentry.io with other applications. n8n has built-in support for a wide range of Sentry.io features, including creating, updating, deleting, and getting, issues, projects, and releases, as well as getting all events.

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

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

  ## Operations

  * Event
      * Get event by ID
      * Get all events
  * Issue
      * Delete an issue
      * Get issue by ID
      * Get all issues
      * Update an issue
  * Project
      * Create a new project
      * Delete a project
      * Get project by ID
      * Get all projects
      * Update a project
  * Release
      * Create a release
      * Delete a release
      * Get release by version identifier
      * Get all releases
      * Update a release
  * Organization
      * Create an organization
      * Get organization by slug
      * Get all organizations
      * Update an organization
  * Team
      * Create a new team
      * Delete a team
      * Get team by slug
      * Get all teams
      * Update a team

  ## Templates and examples

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

  ## Related resources

  Refer to [Sentry.io's documentation](https://docs.sentry.io/api/){: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": "accessToken",
      "options": [
        {
          "name": "Access Token (Cloud)",
          "value": "accessToken"
        },
        {
          "name": "OAuth2 (Cloud)",
          "value": "oAuth2"
        },
        {
          "name": "Access Token (Self Hosted)",
          "value": "accessTokenServer"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "event",
      "options": [
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Issue",
          "value": "issue"
        },
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Project",
          "value": "project"
        },
        {
          "name": "Release",
          "value": "release"
        },
        {
          "name": "Team",
          "value": "team"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get event by ID",
          "action": "Get an event"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many events",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the events belong to. 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": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project the events belong to. 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": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Full",
      "name": "full",
      "type": "boolean",
      "default": true,
      "description": "Whether the event payload will include the full event body, including the stack trace",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "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": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the events belong to. 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": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project the events belong to. 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": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "The ID of the event to retrieve (either the numeric primary-key or the hexadecimal ID as reported by the raven client)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an issue",
          "action": "Delete an issue"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get issue by ID",
          "action": "Get an issue"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many issues",
          "action": "Get many issues"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an issue",
          "action": "Update an issue"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of issue to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the issues belong to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project the issues belong to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "issue"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "issue"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "An optional Sentry structured search query. If not provided, an implied \"is:unresolved\" is assumed. Info <a href=\"https://docs.sentry.io/product/sentry-basics/search/\">here</a>."
        },
        {
          "displayName": "Stats Period",
          "name": "statsPeriod",
          "type": "options",
          "default": "",
          "description": "Time period of stats",
          "options": [
            {
              "name": "14 Days",
              "value": "14d"
            },
            {
              "name": "24 Hours",
              "value": "24h"
            }
          ]
        },
        {
          "displayName": "Short ID Lookup",
          "name": "shortIdLookUp",
          "type": "boolean",
          "default": true,
          "description": "Whether short IDs are looked up by this function as well. This can cause the return value of the function to return an event issue of a different project which is why this is an opt-in."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Issue ID",
      "name": "issueId",
      "type": "string",
      "default": "",
      "description": "ID of issue to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "string",
          "default": "",
          "description": "The actor ID (or username) of the user or team that should be assigned to this issue"
        },
        {
          "displayName": "Has Seen",
          "name": "hasSeen",
          "type": "boolean",
          "default": true,
          "description": "Whether this API call is invoked with a user context this allows changing of the flag that indicates if the user has seen the event"
        },
        {
          "displayName": "Is Bookmarked",
          "name": "isBookmarked",
          "type": "boolean",
          "default": true,
          "description": "Whether this API call is invoked with a user context this allows changing of the bookmark flag"
        },
        {
          "displayName": "Is Public",
          "name": "isPublic",
          "type": "boolean",
          "default": true,
          "description": "Whether to set the issue to public or private"
        },
        {
          "displayName": "Is Subscribed",
          "name": "isSubscribed",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "",
          "description": "The new status for the issue",
          "options": [
            {
              "name": "Ignored",
              "value": "ignored"
            },
            {
              "name": "Resolved",
              "value": "resolved"
            },
            {
              "name": "Resolved Next Release",
              "value": "resolvedInNextRelease"
            },
            {
              "name": "Unresolved",
              "value": "unresolved"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "issue"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an organization",
          "action": "Create an organization"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get organization by slug",
          "action": "Get an organization"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many organizations",
          "action": "Get many organizations"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an organization",
          "action": "Update an organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "organization"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Member",
          "name": "member",
          "type": "boolean",
          "default": true,
          "description": "Whether to restrict results to organizations which you have membership"
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "boolean",
          "default": true,
          "description": "Whether to restrict results to organizations which you are the owner"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team should be created for. 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": [
            "organization"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The slug of the organization the team should be created for",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Agree to Terms",
      "name": "agreeTerms",
      "type": "boolean",
      "default": false,
      "description": "Whether you agree to the applicable terms of service and privacy policy of Sentry.io",
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The unique URL slug for this organization. If this is not provided a slug is automatically generated based on the name."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Slug Name or ID",
      "name": "organization_slug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization to update. 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": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The new name of the organization"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The new URL slug for this organization"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new project",
          "action": "Create a project"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a project",
          "action": "Delete a project"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get project by ID",
          "action": "Get a project"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many projects",
          "action": "Get many projects"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a project",
          "action": "Update a project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the events belong to. 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": [
            "project"
          ],
          "operation": [
            "create",
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project to retrieve. 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": [
            "project"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to create a new project for. 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": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name for the new project",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "Optionally a slug for the new project. If it’s not provided a slug is generated from the name."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the project belong to. 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": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project to update. 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": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bookmarked",
          "name": "isBookmarked",
          "type": "boolean",
          "default": false,
          "description": "The new platform for the updated project"
        },
        {
          "displayName": "Digests Maximum Delay",
          "name": "digestsMaxDelay",
          "type": "number",
          "default": 1800,
          "description": "Maximum interval to digest alerts"
        },
        {
          "displayName": "Digests Minimun Delay",
          "name": "digestsMinDelay",
          "type": "number",
          "default": 60,
          "description": "Minium interval to digest alerts"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The new name for the updated project"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The new slug for the updated project"
        },
        {
          "displayName": "Team",
          "name": "team",
          "type": "string",
          "default": "",
          "description": "The new team name"
        },
        {
          "displayName": "Platform",
          "name": "platform",
          "type": "string",
          "default": "",
          "description": "The new platform for the updated project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the project belong to. 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": [
            "project"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Project Slug Name or ID",
      "name": "projectSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the project to delete. 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": [
            "project"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a release",
          "action": "Create a release"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a release",
          "action": "Delete a release"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get release by version identifier",
          "action": "Get a release by version ID"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many releases",
          "action": "Get many releases"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a release",
          "action": "Update a release"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the releases belong to. 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": [
            "release"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "release"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "release"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "This parameter can be used to create a “starts with” filter for the version"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the release belongs to. 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": [
            "release"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Version",
      "name": "version",
      "type": "string",
      "default": "",
      "description": "The version identifier of the release",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the release belongs to. 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": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Version",
      "name": "version",
      "type": "string",
      "default": "",
      "description": "A version identifier for this release. Can be a version number, a commit hash etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "A URL that points to the release. This can be the path to an online interface to the sourcecode for instance.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Project Names or IDs",
      "name": "projects",
      "type": "multiOptions",
      "default": [],
      "description": "A list of project slugs that are involved in this release. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProjects"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date Released",
          "name": "dateReleased",
          "type": "dateTime",
          "default": "",
          "description": "An optional date that indicates when the release went live. If not provided the current time is assumed."
        },
        {
          "displayName": "Commits",
          "name": "commits",
          "description": "An optional list of commit data to be associated with the release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "commitProperties",
              "displayName": "Commit Properties",
              "values": [
                {
                  "displayName": "ID",
                  "name": "id",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Author Email",
                  "name": "authorEmail",
                  "type": "string",
                  "default": "",
                  "description": "Authors email"
                },
                {
                  "displayName": "Author Name",
                  "name": "authorName",
                  "type": "string",
                  "default": "",
                  "description": "Name of author"
                },
                {
                  "displayName": "Message",
                  "name": "message",
                  "type": "string",
                  "default": "",
                  "description": "Message of commit"
                },
                {
                  "displayName": "Patch Set",
                  "name": "patchSet",
                  "description": "A list of the files that have been changed in the commit. Specifying the patch_set is necessary to power suspect commits and suggested assignees.",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": true
                  },
                  "default": {},
                  "options": [
                    {
                      "name": "patchSetProperties",
                      "displayName": "Patch Set Properties",
                      "values": [
                        {
                          "displayName": "Path",
                          "name": "path",
                          "type": "string",
                          "default": "",
                          "description": "The path to the file. Both forward and backward slashes are supported.",
                          "required": true
                        },
                        {
                          "displayName": "Type",
                          "name": "type",
                          "type": "options",
                          "default": "",
                          "description": "The types of changes that happened in that commit",
                          "options": [
                            {
                              "name": "Add",
                              "value": "add"
                            },
                            {
                              "name": "Modify",
                              "value": "modify"
                            },
                            {
                              "name": "Delete",
                              "value": "delete"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name"
                },
                {
                  "displayName": "Timestamp",
                  "name": "timestamp",
                  "type": "dateTime",
                  "default": "",
                  "description": "Timestamp of commit"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Refs",
          "name": "refs",
          "description": "An optional way to indicate the start and end commits for each repository included in a release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "refProperties",
              "displayName": "Ref Properties",
              "values": [
                {
                  "displayName": "Commit",
                  "name": "commit",
                  "type": "string",
                  "default": "",
                  "description": "The head sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name",
                  "required": true
                },
                {
                  "displayName": "Previous Commit",
                  "name": "previousCommit",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the HEAD of the previous release"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the release belongs to. 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": [
            "release"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Version",
      "name": "version",
      "type": "string",
      "default": "",
      "description": "A version identifier for this release. Can be a version number, a commit hash etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Commits",
          "name": "commits",
          "description": "An optional list of commit data to be associated with the release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "commitProperties",
              "displayName": "Commit Properties",
              "values": [
                {
                  "displayName": "ID",
                  "name": "id",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Author Email",
                  "name": "authorEmail",
                  "type": "string",
                  "default": "",
                  "description": "Authors email"
                },
                {
                  "displayName": "Author Name",
                  "name": "authorName",
                  "type": "string",
                  "default": "",
                  "description": "Name of author"
                },
                {
                  "displayName": "Message",
                  "name": "message",
                  "type": "string",
                  "default": "",
                  "description": "Message of commit"
                },
                {
                  "displayName": "Patch Set",
                  "name": "patchSet",
                  "description": "A list of the files that have been changed in the commit. Specifying the patch_set is necessary to power suspect commits and suggested assignees.",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": true
                  },
                  "default": {},
                  "options": [
                    {
                      "name": "patchSetProperties",
                      "displayName": "Patch Set Properties",
                      "values": [
                        {
                          "displayName": "Path",
                          "name": "path",
                          "type": "string",
                          "default": "",
                          "description": "The path to the file. Both forward and backward slashes are supported.",
                          "required": true
                        },
                        {
                          "displayName": "Type",
                          "name": "type",
                          "type": "options",
                          "default": "",
                          "description": "The types of changes that happened in that commit",
                          "options": [
                            {
                              "name": "Add",
                              "value": "add"
                            },
                            {
                              "name": "Modify",
                              "value": "modify"
                            },
                            {
                              "name": "Delete",
                              "value": "delete"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name"
                },
                {
                  "displayName": "Timestamp",
                  "name": "timestamp",
                  "type": "dateTime",
                  "default": "",
                  "description": "Timestamp of commit"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date Released",
          "name": "dateReleased",
          "type": "dateTime",
          "default": "",
          "description": "An optional date that indicates when the release went live. If not provided the current time is assumed."
        },
        {
          "displayName": "Ref",
          "name": "ref",
          "type": "string",
          "default": "",
          "description": "A URL that points to the release. This can be the path to an online interface to the sourcecode for instance."
        },
        {
          "displayName": "Refs",
          "name": "refs",
          "description": "An optional way to indicate the start and end commits for each repository included in a release",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "refProperties",
              "displayName": "Ref Properties",
              "values": [
                {
                  "displayName": "Commit",
                  "name": "commit",
                  "type": "string",
                  "default": "",
                  "description": "The head sha of the commit",
                  "required": true
                },
                {
                  "displayName": "Repository",
                  "name": "repository",
                  "type": "string",
                  "default": "",
                  "description": "Repository name",
                  "required": true
                },
                {
                  "displayName": "Previous Commit",
                  "name": "previousCommit",
                  "type": "string",
                  "default": "",
                  "description": "The sha of the HEAD of the previous release"
                }
              ]
            }
          ]
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "A URL that points to the release. This can be the path to an online interface to the sourcecode for instance."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "release"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new team",
          "action": "Create a team"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a team",
          "action": "Delete a team"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get team by slug",
          "action": "Get a team"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many teams",
          "action": "Get many teams"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a team",
          "action": "Update a team"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization for which the teams should be listed. 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": [
            "team"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "team"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "team"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to get. 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": [
            "team"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the team",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The optional slug for this team. If not provided it will be auto generated from the name."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to update. 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": [
            "team"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The new name of the team"
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": "",
          "description": "The new slug of the team. Must be unique and available."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "team"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Organization Slug Name or ID",
      "name": "organizationSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the organization the team belongs to. 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": [
            "team"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getOrganizations"
      }
    },
    {
      "displayName": "Team Slug Name or ID",
      "name": "teamSlug",
      "type": "options",
      "default": "",
      "description": "The slug of the team to delete. 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": [
            "team"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams",
        "loadOptionsDependsOn": [
          "organizationSlug"
        ]
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get event by ID"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many events"
    }
  ]

credentials_required:
  [
    {
      "name": "sentryIoOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    },
    {
      "name": "sentryIoApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "sentryIoServerApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessTokenServer"
          ]
        }
      }
    }
  ]


node_type: nodes-base.serviceNowTool
package_name: n8n-nodes-base
display_name: ServiceNow Tool
description: Consume ServiceNow 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-01-06 10:26:56
tool_variant_of: nodes-base.serviceNow
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: ServiceNow node documentation
  description: Learn how to use the ServiceNow node in n8n. Follow technical documentation to integrate ServiceNow node into your workflows.
  contentType: [integration, reference]
  ---

  # ServiceNow node

  Use the ServiceNow node to automate work in ServiceNow, and integrate ServiceNow with other applications. n8n has built-in support for a wide range of ServiceNow features, including getting business services, departments, configuration items, and dictionary as well as creating, updating, and deleting incidents, users, and table records. 

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

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

  ## Operations

  * Business Service
      * Get All
  * Configuration Items
      * Get All
  * Department
      * Get All
  * Dictionary
      * Get All
  * Incident
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Table Record
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * User
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * User Group
      * Get All
  * User Role
      * Get All

  ## Templates and examples

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

  --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 ServiceNow"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "oAuth2",
      "description": "Authentication method to use",
      "options": [
        {
          "name": "Basic Auth",
          "value": "basicAuth"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Attachment",
          "value": "attachment"
        },
        {
          "name": "Business Service",
          "value": "businessService"
        },
        {
          "name": "Configuration Item",
          "value": "configurationItems"
        },
        {
          "name": "Department",
          "value": "department"
        },
        {
          "name": "Dictionary",
          "value": "dictionary"
        },
        {
          "name": "Incident",
          "value": "incident"
        },
        {
          "name": "Table Record",
          "value": "tableRecord"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "User Group",
          "value": "userGroup"
        },
        {
          "name": "User Role",
          "value": "userRole"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload an attachment to a specific table record",
          "action": "Upload an attachment"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an attachment",
          "action": "Delete an attachment"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an attachment",
          "action": "Get an attachment"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many attachments on a table",
          "action": "Get many attachments"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableName",
      "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": [
            "attachment"
          ],
          "operation": [
            "upload",
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Table Record ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Sys_id of the record in the table specified in Table Name that you want to attach the file to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Input Data Field Name",
      "name": "inputDataFieldName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property that contains the data to upload",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "File Name for the Attachment",
          "name": "file_name",
          "type": "string",
          "default": "",
          "description": "Name to give the attachment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Attachment ID",
      "name": "attachmentId",
      "type": "string",
      "default": "",
      "description": "Sys_id value of the attachment to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Attachment ID",
      "name": "attachmentId",
      "type": "string",
      "default": "",
      "description": "Sys_id value of the attachment to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "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": [
            "attachment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Download Attachments",
      "name": "download",
      "type": "boolean",
      "default": false,
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "get",
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Output Field",
      "name": "outputField",
      "type": "string",
      "default": "data",
      "description": "Field name where downloaded data will be placed",
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "get",
            "getAll"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filter",
          "name": "queryFilter",
          "type": "string",
          "placeholder": "<col_name><operator><value>",
          "default": "",
          "description": "An encoded query string used to filter the results",
          "hint": "All parameters are case-sensitive. Queries can contain more than one entry. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More information</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "attachment"
          ],
          "operation": [
            "get",
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many business services"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "businessService"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "businessService"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "businessService"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "businessService"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many configuration items"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "configurationItems"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "configurationItems"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "configurationItems"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "configurationItems"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many departments"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "department"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "department"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "department"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "department"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many dictionaries"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "dictionary"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "dictionary"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "dictionary"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "dictionary"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an incident"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an incident"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an incident"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many incidents"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an incident"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Short Description",
      "name": "short_description",
      "type": "string",
      "default": "",
      "description": "Short description of the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getUsers",
            "loadOptionsDependsOn": [
              "additionalFields.assignment_group"
            ]
          },
          "default": "",
          "description": "Which user is the incident assigned to. Requires the selection of an assignment group. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Assignment Group Name or ID",
          "name": "assignment_group",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAssignmentGroups"
          },
          "default": "",
          "description": "The assignment group of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Business Service Name or ID",
          "name": "business_service",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getBusinessServices"
          },
          "default": ""
        },
        {
          "displayName": "Caller ID",
          "name": "caller_id",
          "type": "string",
          "default": "",
          "description": "The unique identifier of the caller of the incident"
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentCategories"
          },
          "default": "",
          "description": "The category of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Close Notes",
          "name": "close_notes",
          "type": "string",
          "default": "",
          "description": "The close notes for the incident"
        },
        {
          "displayName": "Configuration Item Names or IDs",
          "name": "cmdb_ci",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getConfigurationItems"
          },
          "default": [],
          "description": "Configuration Items, 'cmdb_ci' in metadata. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Contact Type",
          "name": "contact_type",
          "type": "options",
          "options": [
            {
              "name": "Email",
              "value": "email"
            },
            {
              "name": "Phone",
              "value": "phone"
            },
            {
              "name": "Self Service",
              "value": "self-service"
            },
            {
              "name": "Walk In",
              "value": "walk-in"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "The description of the incident"
        },
        {
          "displayName": "Impact",
          "name": "impact",
          "type": "options",
          "options": [
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "Medium",
              "value": 2
            },
            {
              "name": "High",
              "value": 1
            }
          ],
          "default": 1,
          "description": "The impact of the incident"
        },
        {
          "displayName": "Resolution Code Name or ID",
          "name": "close_code",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentResolutionCodes"
          },
          "default": "",
          "description": "The resolution code of the incident, 'close_code' in metadata. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "State Name or ID",
          "name": "state",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentStates"
          },
          "default": "",
          "description": "The state of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Subcategory Name or ID",
          "name": "subcategory",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentSubcategories",
            "loadOptionsDependsOn": [
              "additionalFields.category"
            ]
          },
          "default": "",
          "description": "The subcategory of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Urgency",
          "name": "urgency",
          "type": "options",
          "options": [
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "Medium",
              "value": 2
            },
            {
              "name": "High",
              "value": 1
            }
          ],
          "default": 1,
          "description": "The urgency of the incident"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "incident"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "incident"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Incident ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "delete",
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Incident ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To Name or ID",
          "name": "assigned_to",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getUsers",
            "loadOptionsDependsOn": [
              "additionalFields.assignment_group"
            ]
          },
          "default": "",
          "description": "Which user is the incident assigned to. Requires the selection of an assignment group. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Assignment Group Name or ID",
          "name": "assignment_group",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getAssignmentGroups"
          },
          "default": "",
          "description": "The assignment group of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Business Service Name or ID",
          "name": "business_service",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getBusinessServices"
          },
          "default": ""
        },
        {
          "displayName": "Caller ID",
          "name": "caller_id",
          "type": "string",
          "default": "",
          "description": "The unique identifier of the caller of the incident"
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentCategories"
          },
          "default": "",
          "description": "The category of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Close Notes",
          "name": "close_notes",
          "type": "string",
          "default": "",
          "description": "The close notes for the incident"
        },
        {
          "displayName": "Configuration Item Names or IDs",
          "name": "cmdb_ci",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getConfigurationItems"
          },
          "default": [],
          "description": "Configuration Items, 'cmdb_ci' in metadata. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Contact Type",
          "name": "contact_type",
          "type": "options",
          "options": [
            {
              "name": "Email",
              "value": "email"
            },
            {
              "name": "Phone",
              "value": "phone"
            },
            {
              "name": "Self Service",
              "value": "self-service"
            },
            {
              "name": "Walk In",
              "value": "walk-in"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "The description of the incident"
        },
        {
          "displayName": "Impact",
          "name": "impact",
          "type": "options",
          "options": [
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "Medium",
              "value": 2
            },
            {
              "name": "High",
              "value": 1
            }
          ],
          "default": 1,
          "description": "The impact of the incident"
        },
        {
          "displayName": "Resolution Code Name or ID",
          "name": "close_code",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentResolutionCodes"
          },
          "default": "",
          "description": "The resolution code of the incident. 'close_code' in metadata. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "On Hold Reason Name or ID",
          "name": "hold_reason",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentHoldReasons"
          },
          "default": "",
          "description": "The on hold reason for the incident. It applies if the state is <code>On Hold</code>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "State Name or ID",
          "name": "state",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentStates"
          },
          "default": "",
          "description": "The state of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Subcategory Name or ID",
          "name": "subcategory",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getIncidentSubcategories",
            "loadOptionsDependsOn": [
              "additionalFields.category"
            ]
          },
          "default": "",
          "description": "The subcategory of the incident. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Urgency",
          "name": "urgency",
          "type": "options",
          "options": [
            {
              "name": "Low",
              "value": 3
            },
            {
              "name": "Medium",
              "value": 2
            },
            {
              "name": "High",
              "value": 1
            }
          ],
          "default": 1,
          "description": "The urgency of the incident"
        },
        {
          "displayName": "Work Notes",
          "name": "work_notes",
          "type": "string",
          "default": "",
          "description": "Work notes for the incident"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a table record"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a table record"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a table record"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many table records"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a table record"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableName",
      "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": [
            "tableRecord"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "columns",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "mapInput",
          "description": "Use when node input names match destination field names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "columns",
          "description": "Set the value for each destination column"
        },
        {
          "name": "Nothing",
          "value": "nothing",
          "description": "Don't send any column data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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 inputs.",
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "create"
          ],
          "dataToSend": [
            "mapInput"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsToSend",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "field",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getColumns",
                "loadOptionsDependsOn": [
                  "tableName"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "create"
          ],
          "dataToSend": [
            "columns"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableName",
      "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": [
            "tableRecord"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tableRecord"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tableRecord"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns",
            "loadOptionsDependsOn": [
              "tableName"
            ]
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Name of the table in which the record exists. 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": [
            "tableRecord"
          ],
          "operation": [
            "delete",
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Table Record ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the record",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "delete",
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns",
            "loadOptionsDependsOn": [
              "tableName"
            ]
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableName",
      "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": [
            "tableRecord"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Table Record ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the record",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "columns",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "mapInput",
          "description": "Use when node input names match destination field names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "columns",
          "description": "Set the value for each destination column"
        },
        {
          "name": "Nothing",
          "value": "nothing",
          "description": "Don't send any column data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "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 inputs.",
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "update"
          ],
          "dataToSend": [
            "mapInput"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsToSend",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "field",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "column",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getColumns",
                "loadOptionsDependsOn": [
                  "tableName"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tableRecord"
          ],
          "operation": [
            "update"
          ],
          "dataToSend": [
            "columns"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many users"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Short Description",
      "name": "short_description",
      "type": "string",
      "default": "",
      "description": "Short description of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": false,
          "description": "Whether to activate the user"
        },
        {
          "displayName": "Building",
          "name": "building",
          "type": "string",
          "default": "",
          "description": "The Building address"
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "description": "City of the user"
        },
        {
          "displayName": "Company",
          "name": "company",
          "type": "string",
          "default": "",
          "description": "The name of the company for the user"
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": "",
          "description": "Country of the user"
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "string",
          "default": "",
          "description": "Department of the user"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address associated with the user"
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "The first name of the user"
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "string",
          "default": "",
          "description": "The gender of the user"
        },
        {
          "displayName": "Home Phone",
          "name": "home_phone",
          "type": "string",
          "default": "",
          "description": "Home phone of the user"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "The last name of the user"
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "Location of the user"
        },
        {
          "displayName": "Manager",
          "name": "manager",
          "type": "string",
          "default": "",
          "description": "Manager of the user"
        },
        {
          "displayName": "Middle Name",
          "name": "middle_name",
          "type": "string",
          "default": "",
          "description": "The middle name of the user"
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobile_phone",
          "type": "string",
          "default": "",
          "description": "Mobile phone number of the user"
        },
        {
          "displayName": "Password",
          "name": "user_password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "The user's password"
        },
        {
          "displayName": "Password Needs Reset",
          "name": "password_needs_reset",
          "type": "boolean",
          "default": false,
          "description": "Whether to require a password reset when the user logs in"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The main phone number of the user"
        },
        {
          "displayName": "Role Names or IDs",
          "name": "roles",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getUserRoles"
          },
          "default": [],
          "description": "Roles of the user. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "string",
          "default": "",
          "description": "State for the user"
        },
        {
          "displayName": "Street",
          "name": "street",
          "type": "string",
          "default": "",
          "description": "Street information for the user separated by comma"
        },
        {
          "displayName": "Username",
          "name": "user_name",
          "type": "string",
          "default": "",
          "description": "A username associated with the user (e.g. user_name.123)"
        },
        {
          "displayName": "Zip Code",
          "name": "zip",
          "type": "string",
          "default": "",
          "description": "Zip code for the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "user"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns",
            "loadOptionsDependsOn": [
              "operation"
            ]
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Retrieve Identifier",
      "name": "getOption",
      "type": "options",
      "default": "id",
      "description": "Unique identifier of the user",
      "options": [
        {
          "name": "ID",
          "value": "id"
        },
        {
          "name": "Username",
          "value": "user_name"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Username",
      "name": "user_name",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "getOption": [
            "user_name"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "getOption": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns",
            "loadOptionsDependsOn": [
              "operation"
            ]
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "Unique identifier of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "active",
          "type": "boolean",
          "default": false,
          "description": "Whether to activate the user"
        },
        {
          "displayName": "Building",
          "name": "building",
          "type": "string",
          "default": "",
          "description": "The Building address"
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "description": "City of the user"
        },
        {
          "displayName": "Company",
          "name": "company",
          "type": "string",
          "default": "",
          "description": "The name of the company for the user"
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": "",
          "description": "Country of the user"
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "string",
          "default": "",
          "description": "Department of the user"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address associated with the user"
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "The first name of the user"
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "string",
          "default": "",
          "description": "The gender of the user"
        },
        {
          "displayName": "Home Phone",
          "name": "home_phone",
          "type": "string",
          "default": "",
          "description": "Home phone of the user"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "The last name of the user"
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "Location of the user"
        },
        {
          "displayName": "Manager",
          "name": "manager",
          "type": "string",
          "default": "",
          "description": "Manager of the user"
        },
        {
          "displayName": "Middle Name",
          "name": "middle_name",
          "type": "string",
          "default": "",
          "description": "The middle name of the user"
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobile_phone",
          "type": "string",
          "default": "",
          "description": "Mobile phone number of the user"
        },
        {
          "displayName": "Password",
          "name": "user_password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "description": "The user's password"
        },
        {
          "displayName": "Password Needs Reset",
          "name": "password_needs_reset",
          "type": "boolean",
          "default": false,
          "description": "Whether to require a password reset when the user logs in"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The main phone number of the user"
        },
        {
          "displayName": "Role Names or IDs",
          "name": "roles",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getUserRoles"
          },
          "default": [],
          "description": "Roles of the user. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "string",
          "default": "",
          "description": "State for the user"
        },
        {
          "displayName": "Street",
          "name": "street",
          "type": "string",
          "default": "",
          "description": "Street information for the user separated by comma"
        },
        {
          "displayName": "Username",
          "name": "user_name",
          "type": "string",
          "default": "",
          "description": "A username associated with the user (e.g. user_name.123)"
        },
        {
          "displayName": "Zip Code",
          "name": "zip",
          "type": "string",
          "default": "",
          "description": "Zip code for the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many user groups"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userGroup"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "userGroup"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "userGroup"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userGroup"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many user roles"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userRole"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "userRole"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "userRole"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exclude Reference Link",
          "name": "sysparm_exclude_reference_link",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude Table API links for reference fields"
        },
        {
          "displayName": "Field Names or IDs",
          "name": "sysparm_fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getColumns"
          },
          "default": [],
          "description": "A list of fields to return. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "hint": "String of comma separated values or an array of strings can be set in an expression"
        },
        {
          "displayName": "Filter",
          "name": "sysparm_query",
          "type": "string",
          "default": "",
          "description": "An encoded query string used to filter the results. <a href=\"https://developer.servicenow.com/dev.do#!/learn/learning-plans/quebec/servicenow_application_developer/app_store_learnv2_rest_quebec_more_about_query_parameters\">More info</a>."
        },
        {
          "displayName": "Return Values",
          "name": "sysparm_display_value",
          "type": "options",
          "options": [
            {
              "name": "Actual Values",
              "value": "false"
            },
            {
              "name": "Both",
              "value": "all"
            },
            {
              "name": "Display Values",
              "value": "true"
            }
          ],
          "default": "false",
          "description": "Choose which values to return"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userRole"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Upload an attachment to a specific table record"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an attachment"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an attachment"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many attachments on a table"
    }
  ]

credentials_required:
  [
    {
      "name": "serviceNowOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    },
    {
      "name": "serviceNowBasicApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "basicAuth"
          ]
        }
      }
    }
  ]


