# nodes

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

  # Salesmate node

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

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

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

  ## Operations

  * Activity
      * Create an activity
      * Delete an activity
      * Get an activity
      * Get all companies
      * Update an activity
  * Company
      * Create a company
      * Delete a company
      * Get a company
      * Get all companies
      * Update a company
  * Deal
      * Create a deal
      * Delete a deal
      * Get a deal
      * Get all deals
      * Update a deal

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Activity","value":"activity"},{"name":"Company","value":"company"},{"name":"Deal","value":"deal"}],"default":"activity"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["company"]}},"options":[{"name":"Create","value":"create","description":"Create a company","action":"Create a company"},{"name":"Delete","value":"delete","description":"Delete a company","action":"Delete a company"},{"name":"Get","value":"get","description":"Get a company","action":"Get a company"},{"name":"Get Many","value":"getAll","description":"Get many companies","action":"Get many companies"},{"name":"Update","value":"update","description":"Update a company","action":"Update a company"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["activity"]}},"options":[{"name":"Create","value":"create","description":"Create an activity","action":"Create an activity"},{"name":"Delete","value":"delete","description":"Delete an activity","action":"Delete an activity"},{"name":"Get","value":"get","description":"Get an activity","action":"Get an activity"},{"name":"Get Many","value":"getAll","description":"Get many companies","action":"Get many activities"},{"name":"Update","value":"update","description":"Update an activity","action":"Update an activity"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["deal"]}},"options":[{"name":"Create","value":"create","description":"Create a deal","action":"Create a deal"},{"name":"Delete","value":"delete","description":"Delete a deal","action":"Delete a deal"},{"name":"Get","value":"get","description":"Get a deal","action":"Get a deal"},{"name":"Get Many","value":"getAll","description":"Get many deals","action":"Get many deals"},{"name":"Update","value":"update","description":"Update a deal","action":"Update a deal"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","default":"","displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"required":true},{"displayName":"Owner Name or ID","name":"owner","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getUsers"},"displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"required":true},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["create"]}},"options":[{"displayName":"Website","name":"website","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""},{"displayName":"Other Phone","name":"otherPhone","type":"string","default":""},{"displayName":"Facebook Handle","name":"facebookHandle","type":"string","default":""},{"displayName":"Google Plus Handle","name":"googlePlusHandle","type":"string","default":""},{"displayName":"LinkedIn Handle","name":"linkedInHandle","type":"string","default":""},{"displayName":"Skype ID","name":"skypeId","type":"string","default":""},{"displayName":"Twitter Handle","name":"twitterHandle","type":"string","default":""},{"displayName":"Currency","name":"currency","type":"string","default":""},{"displayName":"Billing Address Line 1","name":"billingAddressLine1","type":"string","default":""},{"displayName":"Billing Address Line 2","name":"billingAddressLine2","type":"string","default":""},{"displayName":"Billing City","name":"billingCity","type":"string","default":""},{"displayName":"Billing Zip Code","name":"billingZipCode","type":"string","default":""},{"displayName":"Billing State","name":"billingState","type":"string","default":""},{"displayName":"Billing Country","name":"billingState","type":"string","default":""},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Tags","name":"tags","type":"string","default":""}]},{"displayName":"Company ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["company"],"operation":["update"]}}},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["update"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["update"]}},"options":[{"displayName":"Name","name":"name","type":"string","default":""},{"displayName":"Owner Name or ID","name":"owner","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getUsers"}},{"displayName":"Website","name":"website","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""},{"displayName":"Other Phone","name":"otherPhone","type":"string","default":""},{"displayName":"Facebook Handle","name":"facebookHandle","type":"string","default":""},{"displayName":"Google Plus Handle","name":"googlePlusHandle","type":"string","default":""},{"displayName":"LinkedIn Handle","name":"linkedInHandle","type":"string","default":""},{"displayName":"Skype ID","name":"skypeId","type":"string","default":""},{"displayName":"Twitter Handle","name":"twitterHandle","type":"string","default":""},{"displayName":"Currency","name":"currency","type":"string","default":""},{"displayName":"Billing Address Line 1","name":"billingAddressLine1","type":"string","default":""},{"displayName":"Billing Address Line 2","name":"billingAddressLine2","type":"string","default":""},{"displayName":"Billing City","name":"billingCity","type":"string","default":""},{"displayName":"Billing Zip Code","name":"billingZipCode","type":"string","default":""},{"displayName":"Billing State","name":"billingState","type":"string","default":""},{"displayName":"Billing Country","name":"billingState","type":"string","default":""},{"displayName":"Description","name":"description","type":"string","default":""},{"displayName":"Tags","name":"tags","type":"string","default":""}]},{"displayName":"Company ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["company"],"operation":["get"]}}},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["get"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["company"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":25},"default":10,"description":"Max number of results to return"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["getAll"],"resource":["company"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["company"],"operation":["getAll"]}},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Comma-separated list of fields to return"},{"displayName":"Sort By","name":"sortBy","type":"string","default":"","description":"The field to sort by"},{"displayName":"Sort Order","name":"sortOrder","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"desc"}]},{"displayName":"Filters","name":"filtersJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"operation":["getAll"],"resource":["company"],"jsonParameters":[true]}}},{"displayName":"Filters","name":"filters","placeholder":"Add filter","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["company"],"operation":["getAll"],"jsonParameters":[false]}},"default":{},"options":[{"name":"filtersUi","displayName":"Filters","values":[{"displayName":"Operator","name":"operator","type":"options","options":[{"name":"AND","value":"AND"},{"name":"OR","value":"OR"}],"default":"AND"},{"displayName":"Conditions","name":"conditions","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"conditionsUi","displayName":"Conditions","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Name","value":"name"},{"name":"Email","value":"email"},{"name":"Phone","value":"phone"}],"default":"name"},{"displayName":"Condition","name":"condition","type":"options","options":[{"name":"Equals","value":"EQUALS"},{"name":"Not Equals","value":"NOT_EQUALS"},{"name":"CONTAINS","value":"Contains"},{"name":"Does Not Contains","value":"DOES_NOT_CONTAINS"},{"name":"Empty","value":"EMPTY"},{"name":"Not Empty","value":"NOT_EMPTY"},{"name":"Starts With","value":"STARTS_WITH"},{"name":"Ends With","value":"ENDS_WITH"}],"default":"EQUALS","description":"Value of the property to set"},{"displayName":"Value","name":"value","type":"string","default":""}]}]}]}]},{"displayName":"Company ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["company"],"operation":["delete"]}},"description":"If more than one company add them separated by ,"},{"displayName":"Title","name":"title","type":"string","default":"","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"required":true},{"displayName":"Owner Name or ID","name":"owner","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getUsers"},"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"required":true},{"displayName":"Type","name":"type","type":"string","default":"","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"description":"This field displays activity type such as call, meeting etc","required":true},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"options":[{"displayName":"Description","name":"description","type":"string","default":"","description":"This field contains details related to the activity"},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"This field contains tags associated with an activity"},{"displayName":"Due Date","name":"dueDate","type":"dateTime","default":"","description":"Expiry date of an activity"},{"displayName":"Duration","name":"duration","type":"number","default":"","description":"Time duration of an activity"},{"displayName":"Is Calendar Invite","name":"isCalendarInvite","type":"boolean","default":false,"description":"Whether to send calendar invite"},{"displayName":"Is Completed","name":"isCompleted","type":"boolean","default":false,"description":"Whether the activity is completed or not"}]},{"displayName":"Activity ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["update"]}}},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["activity"],"operation":["update"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["update"]}},"options":[{"displayName":"Title","name":"title","type":"string","default":""},{"displayName":"Type","name":"type","type":"string","default":""},{"displayName":"Owner","name":"owner","type":"string","default":""},{"displayName":"Description","name":"description","type":"string","default":"","description":"This field contains details related to the activity"},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"This field contains tags associated with an activity"},{"displayName":"Due Date","name":"dueDate","type":"dateTime","default":"","description":"Expiry date of an activity"},{"displayName":"Duration","name":"duration","type":"number","default":"","description":"Time duration of an activity"},{"displayName":"Is Calendar Invite","name":"isCalendarInvite","type":"boolean","default":false,"description":"Whether to send calendar invite"},{"displayName":"Is Completed","name":"isCompleted","type":"boolean","default":false,"description":"Whether the activity is completed or not"}]},{"displayName":"Activity ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["get"]}}},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["activity"],"operation":["get"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["activity"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":25},"default":10,"description":"Max number of results to return"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["getAll"],"resource":["activity"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Comma-separated list of fields to return"},{"displayName":"Sort By","name":"sortBy","type":"string","default":"","description":"The field to sort by"},{"displayName":"Sort Order","name":"sortOrder","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"desc"}]},{"displayName":"Filters","name":"filtersJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"operation":["getAll"],"resource":["activity"],"jsonParameters":[true]}}},{"displayName":"Filters","name":"filters","placeholder":"Add filter","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["activity"],"operation":["getAll"],"jsonParameters":[false]}},"default":{},"options":[{"name":"filtersUi","displayName":"Filters","values":[{"displayName":"Operator","name":"operator","type":"options","options":[{"name":"AND","value":"AND"},{"name":"OR","value":"OR"}],"default":"AND"},{"displayName":"Conditions","name":"conditions","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"conditionsUi","displayName":"Conditions","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Title","value":"title"},{"name":"Tags","value":"tags"}],"default":"title"},{"displayName":"Condition","name":"condition","type":"options","options":[{"name":"Equals","value":"EQUALS"},{"name":"Not Equals","value":"NOT_EQUALS"},{"name":"CONTAINS","value":"Contains"},{"name":"Does Not Contains","value":"DOES_NOT_CONTAINS"},{"name":"Empty","value":"EMPTY"},{"name":"Not Empty","value":"NOT_EMPTY"},{"name":"Starts With","value":"STARTS_WITH"},{"name":"Ends With","value":"ENDS_WITH"}],"default":"EQUALS","description":"Value of the property to set"},{"displayName":"Value","name":"value","type":"string","default":""}]}]}]}]},{"displayName":"Activity ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["delete"]}},"description":"If more than one activity add them separated by ,"},{"displayName":"Title","name":"title","type":"string","default":"","displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"required":true},{"displayName":"Owner Name or ID","name":"owner","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getUsers"},"displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"required":true},{"displayName":"Primary Contact Name or ID","name":"primaryContact","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getContacts"},"displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"description":"Primary contact for the deal. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.","required":true},{"displayName":"Pipeline","name":"pipeline","type":"options","options":[{"name":"Sales","value":"Sales"}],"default":"","displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"required":true},{"displayName":"Status","name":"status","type":"options","default":"Open","options":[{"name":"Open","value":"Open"},{"name":"Close","value":"Close"},{"name":"Lost","value":"Lost"}],"displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"required":true},{"displayName":"Stage","name":"stage","type":"options","default":"","options":[{"name":"New (Untouched)","value":"New (Untouched)"},{"name":"Contacted","value":"Contacted"},{"name":"Qualified","value":"Qualified"},{"name":"In Negotiation","value":"In Negotiation"},{"name":"Proposal Presented","value":"Proposal Presented"}],"displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"required":true},{"displayName":"Currency","name":"currency","type":"string","default":"","displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"required":true},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["deal"],"operation":["create"]}},"options":[{"displayName":"Description","name":"description","type":"string","default":"","description":"This field contains details related to the deal"},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"This field contains tags associated with an deal"},{"displayName":"Primary Company Name or ID","name":"primaryCompany","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCompanies"},"default":""},{"displayName":"Source","name":"source","type":"options","options":[{"name":"Ads","value":"Ads"},{"name":"Referrals","value":"Referrals"},{"name":"Website","value":"Website"},{"name":"Word of Mouth","value":"Word of mouth"}],"default":"Ads"},{"displayName":"Estimated Close Date","name":"estimatedCloseDate","type":"dateTime","default":""},{"displayName":"Deal Value","name":"dealValue","type":"number","typeOptions":{"numberPrecision":2},"default":0},{"displayName":"Priority","name":"priority","type":"options","default":"Medium","options":[{"name":"High","value":"High"},{"name":"Medium","value":"Medium"},{"name":"Low","value":"Low"}]}]},{"displayName":"Deal ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["deal"],"operation":["update"]}}},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["deal"],"operation":["update"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["deal"],"operation":["update"]}},"options":[{"displayName":"Title","name":"title","type":"string","default":""},{"displayName":"Owner Name or ID","name":"owner","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getUsers"}},{"displayName":"Primary Contact Name or ID","name":"primaryContact","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":"","typeOptions":{"loadOptionsMethod":"getContacts"}},{"displayName":"Pipeline","name":"pipeline","type":"options","options":[{"name":"Sales","value":"Sales"}],"default":""},{"displayName":"Status","name":"status","type":"options","default":"Open","options":[{"name":"Open","value":"Open"},{"name":"Close","value":"Close"},{"name":"Lost","value":"Lost"}]},{"displayName":"Stage","name":"stage","type":"options","default":"","options":[{"name":"Contacted","value":"Contacted"},{"name":"In Negotiation","value":"In Negotiation"},{"name":"New (Untouched)","value":"New (Untouched)"},{"name":"Proposal Presented","value":"Proposal Presented"},{"name":"Qualified","value":"Qualified"}]},{"displayName":"Currency","name":"currency","type":"string","default":""},{"displayName":"Description","name":"description","type":"string","default":"","description":"This field contains details related to the deal"},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"This field contains tags associated with an deal"},{"displayName":"Primary Company Name or ID","name":"primaryCompany","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getCompanies"},"default":""},{"displayName":"Source","name":"source","type":"options","options":[{"name":"Ads","value":"Ads"},{"name":"Referrals","value":"Referrals"},{"name":"Website","value":"Website"},{"name":"Word of Mouth","value":"Word of mouth"}],"default":"Ads"},{"displayName":"Estimated Close Date","name":"estimatedCloseDate","type":"dateTime","default":""},{"displayName":"Deal Value","name":"dealValue","type":"number","typeOptions":{"numberPrecision":2},"default":0},{"displayName":"Priority","name":"priority","type":"options","default":"Medium","options":[{"name":"High","value":"High"},{"name":"Medium","value":"Medium"},{"name":"Low","value":"Low"}]}]},{"displayName":"Deal ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["deal"],"operation":["get"]}}},{"displayName":"RAW Data","name":"rawData","type":"boolean","displayOptions":{"show":{"resource":["deal"],"operation":["get"]}},"default":false,"description":"Whether the data should include the fields details"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["deal"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["deal"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":25},"default":10,"description":"Max number of results to return"},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["getAll"],"resource":["deal"]}}},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["deal"],"operation":["getAll"]}},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Comma-separated list of fields to return"},{"displayName":"Sort By","name":"sortBy","type":"string","default":"","description":"The field to sort by"},{"displayName":"Sort Order","name":"sortOrder","type":"options","options":[{"name":"ASC","value":"asc"},{"name":"DESC","value":"desc"}],"default":"desc"}]},{"displayName":"Filters","name":"filtersJson","type":"json","typeOptions":{"alwaysOpenEditWindow":true},"default":"","displayOptions":{"show":{"operation":["getAll"],"resource":["deal"],"jsonParameters":[true]}}},{"displayName":"Filters","name":"filters","placeholder":"Add filter","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["deal"],"operation":["getAll"],"jsonParameters":[false]}},"default":{},"options":[{"name":"filtersUi","displayName":"Filters","values":[{"displayName":"Operator","name":"operator","type":"options","options":[{"name":"AND","value":"AND"},{"name":"OR","value":"OR"}],"default":"AND"},{"displayName":"Conditions","name":"conditions","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"conditionsUi","displayName":"Conditions","values":[{"displayName":"Field","name":"field","type":"options","options":[{"name":"Title","value":"title"},{"name":"Tags","value":"tags"},{"name":"Last Communication Mode","value":"lastCommunicationMode"}],"default":"title"},{"displayName":"Condition","name":"condition","type":"options","options":[{"name":"Equals","value":"EQUALS"},{"name":"Not Equals","value":"NOT_EQUALS"},{"name":"CONTAINS","value":"Contains"},{"name":"Does Not Contains","value":"DOES_NOT_CONTAINS"},{"name":"Empty","value":"EMPTY"},{"name":"Not Empty","value":"NOT_EMPTY"},{"name":"Starts With","value":"STARTS_WITH"},{"name":"Ends With","value":"ENDS_WITH"}],"default":"EQUALS","description":"Value of the property to set"},{"displayName":"Value","name":"value","type":"string","default":""}]}]}]}]},{"displayName":"Deal ID","name":"id","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["deal"],"operation":["delete"]}},"description":"If more than one deal add them separated by ,"}]

operations:
  [{"type":"resource","resource":"activity","name":"Activity"},{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"deal","name":"Deal"},{"type":"operation","operation":"create","name":"Create","action":"Create a company","resources":["company"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a company","resources":["company"]},{"type":"operation","operation":"get","name":"Get","action":"Get a company","resources":["company"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many companies","resources":["company"]},{"type":"operation","operation":"update","name":"Update","action":"Update a company","resources":["company"]},{"type":"operation","operation":"create","name":"Create","action":"Create an activity","resources":["activity"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an activity","resources":["activity"]},{"type":"operation","operation":"get","name":"Get","action":"Get an activity","resources":["activity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many activities","resources":["activity"]},{"type":"operation","operation":"update","name":"Update","action":"Update an activity","resources":["activity"]},{"type":"operation","operation":"create","name":"Create","action":"Create a deal","resources":["deal"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a deal","resources":["deal"]},{"type":"operation","operation":"get","name":"Get","action":"Get a deal","resources":["deal"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many deals","resources":["deal"]},{"type":"operation","operation":"update","name":"Update","action":"Update a deal","resources":["deal"]}]


node_type: scheduleTrigger
package_name: n8n-nodes-base
display_name: Schedule Trigger
description: Triggers the workflow on a given schedule
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Schedule Trigger node documentation
  description: Learn how to use the Schedule Trigger node in n8n. Follow technical documentation to integrate Schedule Trigger node into your workflows.
  contentType: [integration, reference]
  priority: critical
  ---

  # Schedule Trigger node

  Use the Schedule Trigger node to run workflows at fixed intervals and times. This works in a similar way to the Cron software utility in Unix-like systems.

  /// note | You must activate the workflow
  If a workflow uses the Schedule node as a trigger, make sure that you save and activate the workflow. 
  ///

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

  ## Node parameters

  Add **Trigger Rules** to determine when the trigger should run.

  Use the **Trigger Interval** to select the time interval unit of measure to schedule the trigger for. All other parameters depend on the interval you select. Choose from:

  - [Seconds trigger interval](#seconds-trigger-interval)
  - [Minutes trigger interval](#minutes-trigger-interval)
  - [Hours trigger interval](#hours-trigger-interval)
  - [Days trigger interval](#days-trigger-interval)
  - [Weeks trigger interval](#weeks-trigger-interval)
  - [Months trigger interval](#months-trigger-interval)
  - [Custom (Cron) interval](#custom-cron-interval)

  You can add multiple **Trigger Rules** to run the node on different schedules.

  Refer to the sections below for more detail on configuring each **Trigger Interval**. Refer to [Templates and examples](#templates-and-examples) for further examples.

  ### Seconds trigger interval

  * **Seconds Between Triggers**: Enter the number of seconds between each workflow trigger. For example, if you enter `30` here, the trigger will run every 30 seconds.

  ### Minutes trigger interval

  * **Minutes Between Triggers**: Enter the number of minutes between each workflow trigger. For example, if you enter `5` here, the trigger will run every 5 minutes.

  ### Hours trigger interval

  * **Hours Between Triggers**: Enter the number of hours between each workflow trigger.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  For example, if you enter `6` **Hours Between Triggers** and `30` **Trigger at Minute**, the node will run every six hours at 30 minutes past the hour.

  ### Days trigger interval

  * **Days Between Triggers**: Enter the number of days between each workflow trigger.
  * **Trigger at Hour**: Select the hour of the day to trigger the node.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  <!-- vale from-microsoft.AMPM = NO -->
  For example, if you enter `2` **Days Between Triggers**, **9am** for **Trigger at Hour**, and `15` **Trigger at Minute**, the node will run every two days at 9:15am.
  <!-- vale from-microsoft.AMPM = YES -->

  ### Weeks trigger interval

  * **Weeks Between Triggers**: Enter the number of weeks between each workflow trigger.
  * **Trigger on Weekdays**: Select the day(s) of the week you want to trigger the node.
  * **Trigger at Hour**: Select the hour of the day to trigger the node.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  For example, if you enter `2` **Weeks Between Triggers**, **Monday** for **Trigger on Weekdays**, **3pm** for **Trigger at Hour**, and `30` **Trigger at Minute**, the node will run every two weeks on Monday at 3:30 PM.

  ### Months trigger interval

  * **Months Between Triggers**: Enter the number of months between each workflow trigger.
  * **Trigger at Day of Month**: Enter the day of the month the day should trigger at, from `1` to `31`. If a month doesn't have this day, the node won't trigger. For example, if you enter `30` here, the node won't trigger in February.
  * **Trigger at Hour**: Select the hour of the day to trigger the node.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  For example, if you enter `3` **Months Between Triggers**, `28` **Trigger at Day of Month**, **9am** for **Trigger at Hour**, and `0` **Trigger at Minute**, the node will run each quarter on the 28th day of the month at 9:00 AM.

  ### Custom (Cron) interval

  Enter a custom cron **Expression** to set the schedule for the trigger.

  To generate a Cron expression, you can use [crontab guru](https://crontab.guru){:target=_blank .external-link}. Paste the Cron expression that you generated using crontab guru in the **Expression** field in n8n.

  #### Examples

  <!-- vale from-write-good.Weasel = NO -->
  |Type|Cron Expression|Description|
  |---|---|---|
  |Every X Seconds|`*/10 * * * * *`|Every 10 seconds.|
  |Every X Minutes|`*/5 * * * *`|Every 5 minutes.|
  |Hourly|`0 * * * *`|Every hour on the hour.|
  |Daily|`0 6 * * *`|At 6:00 AM every day.|
  |Weekly|`0 12 * * 1`|At noon every Monday.|
  |Monthly|`0 0 1 * *`|At midnight on the 1st of every month.|
  |Every X Days|`0 0 */3 * *`|At midnight every 3rd day.|
  |Only Weekdays|`0 9 * * 1-5`|At 9:00 AM Monday through Friday.|
  |Custom Hourly Range|`0 9-17 * * *`|Every hour from 9:00 AM to 5:00 PM every day.|
  |Quarterly|`0 0 1 1,4,7,10 *`|At midnight on the 1st of January, April, July, and October.|
  <!-- vale from-write-good.Weasel = YES -->

  /// warning | Using variables in the Cron expression
  While variables can be used in the scheduled trigger, their values only get evaluated when the workflow is activated. If you alter a variable's value in the settings after a workflow is activated, the changes won't alter the cron schedule. To re-evaluate the variable, set the workflow to **Inactive** and then back to **Active** again
  /// 

  #### Why there are six asterisks in the Cron expression

  The sixth asterisk in the Cron expression represents seconds. Setting this is optional. The node will execute even if you don't set the value for seconds.

  |  (*)  |  *  |  *  |  *  |  *  |  *  |
  |:--:|:--:|:--:|:--:|:--:|:--:|
  |(second)|minute|hour|day of month|month|day of week(Sun-Sat)|

  ## Templates and examples

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

  ## Common issues

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

properties_schema:
  [{"displayName":"This workflow will run on the schedule you define here once you <a data-key=\"activate\">activate</a> it.<br><br>For testing, you can also trigger it manually: by going back to the canvas and clicking ‘execute workflow’","name":"notice","type":"notice","default":""},{"displayName":"Trigger Rules","name":"rule","placeholder":"Add Rule","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{"interval":[{"field":"days"}]},"options":[{"name":"interval","displayName":"Trigger Interval","values":[{"displayName":"Trigger Interval","name":"field","type":"options","default":"days","options":[{"name":"Seconds","value":"seconds"},{"name":"Minutes","value":"minutes"},{"name":"Hours","value":"hours"},{"name":"Days","value":"days"},{"name":"Weeks","value":"weeks"},{"name":"Months","value":"months"},{"name":"Custom (Cron)","value":"cronExpression"}]},{"displayName":"Seconds Between Triggers","name":"secondsInterval","type":"number","default":30,"displayOptions":{"show":{"field":["seconds"]}},"description":"Number of seconds between each workflow trigger"},{"displayName":"Minutes Between Triggers","name":"minutesInterval","type":"number","default":5,"displayOptions":{"show":{"field":["minutes"]}},"description":"Number of minutes between each workflow trigger"},{"displayName":"Hours Between Triggers","name":"hoursInterval","type":"number","displayOptions":{"show":{"field":["hours"]}},"default":1,"description":"Number of hours between each workflow trigger"},{"displayName":"Days Between Triggers","name":"daysInterval","type":"number","displayOptions":{"show":{"field":["days"]}},"default":1,"description":"Number of days between each workflow trigger"},{"displayName":"Weeks Between Triggers","name":"weeksInterval","type":"number","displayOptions":{"show":{"field":["weeks"]}},"default":1,"description":"Would run every week unless specified otherwise"},{"displayName":"Months Between Triggers","name":"monthsInterval","type":"number","displayOptions":{"show":{"field":["months"]}},"default":1,"description":"Would run every month unless specified otherwise"},{"displayName":"Trigger at Day of Month","name":"triggerAtDayOfMonth","type":"number","displayOptions":{"show":{"field":["months"]}},"typeOptions":{"minValue":1,"maxValue":31},"default":1,"description":"The day of the month to trigger (1-31)","hint":"If a month doesn’t have this day, the node won’t trigger"},{"displayName":"Trigger on Weekdays","name":"triggerAtDay","type":"multiOptions","displayOptions":{"show":{"field":["weeks"]}},"typeOptions":{"maxValue":7},"options":[{"name":"Monday","value":1},{"name":"Tuesday","value":2},{"name":"Wednesday","value":3},{"name":"Thursday","value":4},{"name":"Friday","value":5},{"name":"Saturday","value":6},{"name":"Sunday","value":0}],"default":[0]},{"displayName":"Trigger at Hour","name":"triggerAtHour","type":"options","default":0,"displayOptions":{"show":{"field":["days","weeks","months"]}},"options":[{"name":"Midnight","displayName":"Midnight","value":0},{"name":"1am","displayName":"1am","value":1},{"name":"2am","displayName":"2am","value":2},{"name":"3am","displayName":"3am","value":3},{"name":"4am","displayName":"4am","value":4},{"name":"5am","displayName":"5am","value":5},{"name":"6am","displayName":"6am","value":6},{"name":"7am","displayName":"7am","value":7},{"name":"8am","displayName":"8am","value":8},{"name":"9am","displayName":"9am","value":9},{"name":"10am","displayName":"10am","value":10},{"name":"11am","displayName":"11am","value":11},{"name":"Noon","displayName":"Noon","value":12},{"name":"1pm","displayName":"1pm","value":13},{"name":"2pm","displayName":"2pm","value":14},{"name":"3pm","displayName":"3pm","value":15},{"name":"4pm","displayName":"4pm","value":16},{"name":"5pm","displayName":"5pm","value":17},{"name":"6pm","displayName":"6pm","value":18},{"name":"7pm","displayName":"7pm","value":19},{"name":"8pm","displayName":"8pm","value":20},{"name":"9pm","displayName":"9pm","value":21},{"name":"10pm","displayName":"10pm","value":22},{"name":"11pm","displayName":"11pm","value":23}],"description":"The hour of the day to trigger"},{"displayName":"Trigger at Minute","name":"triggerAtMinute","type":"number","default":0,"displayOptions":{"show":{"field":["hours","days","weeks","months"]}},"typeOptions":{"minValue":0,"maxValue":59},"description":"The minute past the hour to trigger (0-59)"},{"displayName":"You can find help generating your cron expression <a href=\"https://crontab.guru/examples.html\" target=\"_blank\">here</a>","name":"notice","type":"notice","displayOptions":{"show":{"field":["cronExpression"]}},"default":""},{"displayName":"Expression","name":"expression","type":"string","default":"","placeholder":"eg. 0 15 * 1 sun","displayOptions":{"show":{"field":["cronExpression"]}},"hint":"Format: [Minute] [Hour] [Day of Month] [Month] [Day of Week]"}]}]}]


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

  # SeaTable node

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

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

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

  ## Operations

  * Row
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Row","value":"row"}],"default":"row"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Create","value":"create","description":"Create a row","action":"Create a row"},{"name":"Delete","value":"delete","description":"Delete a row","action":"Delete a row"},{"name":"Get","value":"get","description":"Get a row","action":"Get a row"},{"name":"Get Many","value":"getAll","description":"Get many rows","action":"Get many rows"},{"name":"Update","value":"update","description":"Update a row","action":"Update a row"}],"default":"create","description":"The operation being performed"},{"displayName":"Table Name or ID","name":"tableName","type":"options","placeholder":"Name of table","required":true,"typeOptions":{"loadOptionsMethod":"getTableNames"},"displayOptions":{"hide":{"operation":["get"]}},"default":"","description":"The name of SeaTable table to access. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Table Name or ID","name":"tableId","type":"options","placeholder":"Name of table","required":true,"typeOptions":{"loadOptionsMethod":"getTableIds"},"displayOptions":{"show":{"operation":["get"]}},"default":"","description":"The name of SeaTable table to access. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Row ID","name":"rowId","type":"string","displayOptions":{"show":{"operation":["update"]}},"default":""},{"displayName":"Data to Send","name":"fieldsToSend","type":"options","options":[{"name":"Auto-Map Input Data to Columns","value":"autoMapInputData","description":"Use when node input properties match destination column names"},{"name":"Define Below for Each Column","value":"defineBelow","description":"Set the value for each destination column"}],"displayOptions":{"show":{"operation":["create","update"]}},"default":"defineBelow","description":"Whether to insert the input data this node receives in the new row"},{"displayName":"Inputs to Ignore","name":"inputsToIgnore","type":"string","displayOptions":{"show":{"operation":["create","update"],"fieldsToSend":["autoMapInputData"]}},"default":"","description":"List of input properties to avoid sending, separated by commas. Leave empty to send all properties.","placeholder":"Enter properties..."},{"displayName":"Columns to Send","name":"columnsUi","placeholder":"Add Column","type":"fixedCollection","typeOptions":{"multipleValueButtonText":"Add Column to Send","multipleValues":true},"options":[{"displayName":"Column","name":"columnValues","values":[{"displayName":"Column Name or ID","name":"columnName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsDependsOn":["table"],"loadOptionsMethod":"getTableUpdateAbleColumns"},"default":""},{"displayName":"Column Value","name":"columnValue","type":"string","default":""}]}],"displayOptions":{"show":{"operation":["create","update"],"fieldsToSend":["defineBelow"]}},"default":{},"description":"Add destination column with its value"},{"displayName":"Row ID","name":"rowId","type":"string","displayOptions":{"show":{"operation":["delete"]}},"default":""},{"displayName":"Row ID","name":"rowId","type":"string","displayOptions":{"show":{"operation":["get"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"]}},"default":true,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"operation":["getAll"]}},"options":[{"displayName":"View Name or ID","name":"view_name","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getViews"},"default":""}]},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"operation":["getAll"]}},"options":[{"displayName":"Convert Link ID","name":"convert_link_id","type":"boolean","default":false,"description":"Whether the link column in the returned row is the ID of the linked row or the name of the linked row"},{"displayName":"Direction","name":"direction","type":"options","options":[{"name":"Ascending","value":"asc"},{"name":"Descending","value":"desc"}],"default":"asc","description":"The direction of the sort, ascending (asc) or descending (desc)"},{"displayName":"Order By","name":"order_by","type":"options","typeOptions":{"loadOptionsMethod":"getAllSortableColumns"},"default":"","description":"A column's name or ID, use this column to sort the rows. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]}]


node_type: seaTableTrigger
package_name: n8n-nodes-base
display_name: SeaTable Trigger
description: Starts the workflow when SeaTable events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"seaTableApi","required":true}]
updated_at: 2025-06-12 12:00:45
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":"Table Name or ID","name":"tableName","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"getTableNames"},"default":"","description":"The name of SeaTable table to access. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Event","name":"event","type":"options","options":[{"name":"Row Created","value":"rowCreated","description":"Trigger on newly created rows"}],"default":"rowCreated"},{"displayName":"Simplify","name":"simple","type":"boolean","default":true,"description":"Whether to return a simplified version of the response instead of the raw data"}]


node_type: 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}]
updated_at: 2025-06-12 12:00:45
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","noDataExpression":true,"required":true,"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"}],"default":"company"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"displayOptions":{"show":{"resource":["company"]}},"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"}],"default":"getFactor"},{"displayName":"Scorecard Identifier","name":"scorecardIdentifier","description":"Primary identifier of a company or scorecard, i.e. domain.","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["company"],"operation":["getScorecard","getFactor","getFactorHistorical","getHistoricalScore","getScorePlan"]}}},{"displayName":"Score","name":"score","description":"Score target","type":"number","displayOptions":{"show":{"resource":["company"],"operation":["getScorePlan"]}},"required":true,"default":0},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["getFactor","getFactorHistorical","getHistoricalScore","getScorePlan"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["company"],"operation":["getFactor","getFactorHistorical","getHistoricalScore","getScorePlan"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"resource":["company"],"operation":["getFactorHistorical","getHistoricalScore"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Filters","name":"filters","displayOptions":{"show":{"resource":["company"],"operation":["getFactor"]}},"type":"collection","placeholder":"Add Filter","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":""}]},{"displayName":"Options","name":"options","displayOptions":{"show":{"resource":["company"],"operation":["getFactorHistorical","getHistoricalScore"]}},"type":"collection","placeholder":"Add Option","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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"displayOptions":{"show":{"resource":["industry"]}},"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"}],"default":"getFactor"},{"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","displayOptions":{"show":{"resource":["industry"],"operation":["getFactor","getFactorHistorical"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["industry"],"operation":["getFactor","getFactorHistorical"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"resource":["industry"],"operation":["getFactor","getFactorHistorical"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","displayOptions":{"show":{"resource":["industry"],"operation":["getFactorHistorical"]}},"type":"collection","placeholder":"Add Option","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":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"displayOptions":{"show":{"resource":["invite"]}},"options":[{"name":"Create","value":"create","description":"Create an invite for a company/user","action":"Create an invite"}],"default":"create"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","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","description":"Message for the invitee","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["invite"],"operation":["create"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["invite"],"operation":["create"]}},"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":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"displayOptions":{"show":{"resource":["portfolio"]}},"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"}],"default":"create"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["portfolio"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["portfolio"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Portfolio ID","name":"portfolioId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["portfolio"],"operation":["update","delete"]}}},{"displayName":"Portfolio Name","name":"name","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["portfolio"],"operation":["create","update"]}},"description":"Name of the portfolio"},{"displayName":"Description","name":"description","type":"string","default":"","displayOptions":{"show":{"resource":["portfolio"],"operation":["create","update"]}}},{"displayName":"Privacy","name":"privacy","type":"options","displayOptions":{"show":{"resource":["portfolio"],"operation":["create","update"]}},"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"}],"default":"shared"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"displayOptions":{"show":{"resource":["portfolioCompany"]}},"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"}],"default":"add"},{"displayName":"Portfolio ID","name":"portfolioId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["portfolioCompany"],"operation":["getAll","add","remove"]}}},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["portfolioCompany"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["portfolioCompany"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","displayOptions":{"show":{"resource":["portfolioCompany"],"operation":["getAll"]}},"type":"collection","placeholder":"Add Filter","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":""}]},{"displayName":"Domain","name":"domain","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["portfolioCompany"],"operation":["add","remove"]}},"description":"Company's domain name"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"required":true,"displayOptions":{"show":{"resource":["report"]}},"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"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["report"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["report"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"},{"displayName":"Report","name":"report","type":"options","required":true,"displayOptions":{"show":{"resource":["report"],"operation":["generate"]}},"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"}],"default":"detailed"},{"displayName":"Scorecard Identifier","name":"scorecardIdentifier","description":"Primary identifier of a company or scorecard, i.e. domain.","type":"string","required":true,"default":"","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","required":true,"default":"","displayOptions":{"show":{"resource":["report"],"operation":["generate"],"report":["portfolio"]}}},{"displayName":"Branding","name":"branding","type":"options","displayOptions":{"show":{"resource":["report"],"operation":["generate"],"report":["detailed","summary"]}},"options":[{"name":"SecurityScorecard","value":"securityscorecard"},{"name":"Company and SecurityScorecard","value":"company_and_securityscorecard"},{"name":"Company","value":"company"}],"default":"securityscorecard"},{"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":{},"placeholder":"Add Field","displayOptions":{"show":{"resource":["report"],"operation":["generate"],"report":["issues","portfolio"]}},"options":[{"displayName":"Format","name":"format","type":"options","default":"pdf","options":[{"name":"CSV","value":"csv"},{"name":"PDF","value":"pdf"}]}]},{"displayName":"Options","name":"options","type":"collection","default":{},"placeholder":"Add Field","displayOptions":{"show":{"resource":["report"],"operation":["generate"],"report":["scorecard-footprint"]}},"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":[]}]},{"displayName":"Report URL","name":"url","type":"string","default":"","required":true,"description":"URL to a generated report","displayOptions":{"show":{"resource":["report"],"operation":["download"]}}},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","required":true,"default":"data","displayOptions":{"show":{"resource":["report"],"operation":["download"]}},"description":"Name of the binary property to which to write the data of the read file"}]

operations:
  [{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"industry","name":"Industry"},{"type":"resource","resource":"invite","name":"Invite"},{"type":"resource","resource":"portfolio","name":"Portfolio"},{"type":"resource","resource":"portfolioCompany","name":"Portfolio Company"},{"type":"resource","resource":"report","name":"Report"},{"type":"operation","operation":"getFactor","name":"Get Factor Scores","action":"Get a company factor scores and issue counts","resources":["company"]},{"type":"operation","operation":"getFactorHistorical","name":"Get Historical Factor Scores","action":"Get a company's historical factor scores","resources":["company"]},{"type":"operation","operation":"getHistoricalScore","name":"Get Historical Scores","action":"Get a company's historical scores","resources":["company"]},{"type":"operation","operation":"getScorecard","name":"Get Information and Scorecard","action":"Get company information and a summary of their scorecard","resources":["company"]},{"type":"operation","operation":"getScorePlan","name":"Get Score Plan","action":"Get a company's score improvement plan","resources":["company"]},{"type":"operation","operation":"getFactor","name":"Get Factor Scores","action":"Get factor scores for an industry","resources":["industry"]},{"type":"operation","operation":"getFactorHistorical","name":"Get Historical Factor Scores","action":"Get historical factor scores for an industry","resources":["industry"]},{"type":"operation","operation":"getScore","name":"Get Score","action":"Get the score for an industry","resources":["industry"]},{"type":"operation","operation":"create","name":"Create","action":"Create an invite","resources":["invite"]},{"type":"operation","operation":"create","name":"Create","action":"Create a portfolio","resources":["portfolio"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a portfolio","resources":["portfolio"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many portfolios","resources":["portfolio"]},{"type":"operation","operation":"update","name":"Update","action":"Update a portfolio","resources":["portfolio"]},{"type":"operation","operation":"add","name":"Add","action":"Add a portfolio company","resources":["portfolioCompany"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many portfolio companies","resources":["portfolioCompany"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a portfolio company","resources":["portfolioCompany"]},{"type":"operation","operation":"download","name":"Download","action":"Download a report","resources":["report"]},{"type":"operation","operation":"generate","name":"Generate","action":"Generate a report","resources":["report"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many reports","resources":["report"]}]


node_type: segment
package_name: n8n-nodes-base
display_name: Segment
description: Consume Segment API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"segmentApi","required":true}]
updated_at: 2025-06-12 12:00:45
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","noDataExpression":true,"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"}],"default":"identify"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["group"]}},"options":[{"name":"Add","value":"add","description":"Add a user to a group","action":"Add a user to a group"}],"default":"add"},{"displayName":"User ID","name":"userId","type":"string","default":"","displayOptions":{"show":{"resource":["group"],"operation":["add"]}}},{"displayName":"Group ID","name":"groupId","type":"string","default":"","displayOptions":{"show":{"resource":["group"],"operation":["add"]}},"description":"A Group ID is the unique identifier which you recognize a group by in your own database","required":true},{"displayName":"Traits","name":"traits","placeholder":"Add Trait","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["group"],"operation":["add"]}},"default":{},"options":[{"name":"traitsUi","displayName":"Trait","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Context","name":"context","placeholder":"Add Context","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["group"],"operation":["add"]}},"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":""}]}]}]}]},{"displayName":"Integration","name":"integrations","placeholder":"Add Integration","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["group"],"operation":["add"]}},"default":{},"options":[{"name":"integrationsUi","displayName":"Integration","values":[{"displayName":"All","name":"all","type":"boolean","default":true},{"displayName":"Salesforce","name":"salesforce","type":"boolean","default":false}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["identify"]}},"options":[{"name":"Create","value":"create","description":"Create an identity","action":"Create an identity"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["track"]}},"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"}],"default":"event"},{"displayName":"User ID","name":"userId","type":"string","default":"","displayOptions":{"show":{"resource":["identify"],"operation":["create"]}}},{"displayName":"Traits","name":"traits","placeholder":"Add Trait","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["identify"],"operation":["create"]}},"default":{},"options":[{"name":"traitsUi","displayName":"Trait","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Context","name":"context","placeholder":"Add Context","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["identify"],"operation":["create"]}},"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":""}]}]}]}]},{"displayName":"Integration","name":"integrations","placeholder":"Add Integration","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["identify"],"operation":["create"]}},"default":{},"options":[{"name":"integrationsUi","displayName":"Integration","values":[{"displayName":"All","name":"all","type":"boolean","default":true},{"displayName":"Salesforce","name":"salesforce","type":"boolean","default":false}]}]},{"displayName":"User ID","name":"userId","type":"string","default":"","displayOptions":{"show":{"resource":["track"],"operation":["event"]}}},{"displayName":"Event","name":"event","type":"string","default":"","displayOptions":{"show":{"resource":["track"],"operation":["event"]}},"description":"Name of the action that a user has performed","required":true},{"displayName":"Context","name":"context","placeholder":"Add Context","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["track"],"operation":["event"]}},"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":""}]}]}]}]},{"displayName":"Integration","name":"integrations","placeholder":"Add Integration","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["track"],"operation":["event"]}},"default":{},"options":[{"name":"integrationsUi","displayName":"Integration","values":[{"displayName":"All","name":"all","type":"boolean","default":true},{"displayName":"Salesforce","name":"salesforce","type":"boolean","default":false}]}]},{"displayName":"Properties","name":"properties","placeholder":"Add Properties","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["track"],"operation":["event"]}},"default":{},"options":[{"name":"propertiesUi","displayName":"Property","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"User ID","name":"userId","type":"string","default":"","displayOptions":{"show":{"resource":["track"],"operation":["page"]}}},{"displayName":"Name","name":"name","type":"string","default":"","displayOptions":{"show":{"resource":["track"],"operation":["page"]}},"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"},{"displayName":"Context","name":"context","placeholder":"Add Context","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["track"],"operation":["page"]}},"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":""}]}]}]}]},{"displayName":"Integration","name":"integrations","placeholder":"Add Integration","type":"fixedCollection","typeOptions":{"multipleValues":false},"displayOptions":{"show":{"resource":["track"],"operation":["page"]}},"default":{},"options":[{"name":"integrationsUi","displayName":"Integration","values":[{"displayName":"All","name":"all","type":"boolean","default":true},{"displayName":"Salesforce","name":"salesforce","type":"boolean","default":false}]}]},{"displayName":"Properties","name":"properties","placeholder":"Add Properties","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["track"],"operation":["page"]}},"default":{},"options":[{"name":"propertiesUi","displayName":"Property","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]}]

operations:
  [{"type":"resource","resource":"group","name":"Group"},{"type":"resource","resource":"identify","name":"Identify"},{"type":"resource","resource":"track","name":"Track"},{"type":"operation","operation":"add","name":"Add","action":"Add a user to a group","resources":["group"]},{"type":"operation","operation":"create","name":"Create","action":"Create an identity","resources":["identify"]},{"type":"operation","operation":"event","name":"Event","action":"Track an event","resources":["track"]},{"type":"operation","operation":"page","name":"Page","action":"Track a page","resources":["track"]}]


node_type: 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}]
updated_at: 2025-06-12 12:00:45
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","noDataExpression":true,"options":[{"name":"Contact","value":"contact"},{"name":"List","value":"list"},{"name":"Mail","value":"mail"}],"default":"list","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["list"]}},"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"}],"default":"create"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["list"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["list"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"default":100,"description":"Max number of results to return"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["list"]}},"default":"","description":"Name of the list"},{"displayName":"List ID","name":"listId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["list"]}},"default":"","description":"ID of the list"},{"displayName":"Delete Contacts","name":"deleteContacts","type":"boolean","default":false,"displayOptions":{"show":{"operation":["delete"],"resource":["list"]}},"description":"Whether to delete all contacts on the list"},{"displayName":"List ID","name":"listId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["list"]}},"default":"","description":"ID of the list"},{"displayName":"Contact Sample","name":"contactSample","type":"boolean","default":false,"displayOptions":{"show":{"operation":["get"],"resource":["list"]}},"description":"Whether to return the contact sample"},{"displayName":"List ID","name":"listId","type":"string","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["list"]}},"default":"","description":"ID of the list"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["list"]}},"default":"","description":"Name of the list"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"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"}],"default":"upsert"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":1000},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"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"}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"displayOptions":{"show":{"operation":["upsert"],"resource":["contact"]}},"default":"","description":"Primary email for the contact"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"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-examples/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-examples/expressions/\">expression</a>."},{"displayName":"Field Value","name":"fieldValue","type":"string","default":"","description":"Value for the field"}]}]}]},{"displayName":"Contact IDs","name":"ids","type":"string","default":"","displayOptions":{"show":{"resource":["contact"],"operation":["delete"],"deleteAll":[false]}},"description":"ID of the contact. Multiple can be added separated by comma."},{"displayName":"Delete All","name":"deleteAll","type":"boolean","displayOptions":{"show":{"resource":["contact"],"operation":["delete"]}},"default":false,"description":"Whether all contacts will be deleted"},{"displayName":"By","name":"by","type":"options","options":[{"name":"ID","value":"id"},{"name":"Email","value":"email"}],"required":true,"displayOptions":{"show":{"operation":["get"],"resource":["contact"]}},"default":"id","description":"Search the user by ID or email"},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["contact"],"by":["id"]}},"default":"","description":"ID of the contact"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["contact"],"by":["email"]}},"default":"","description":"Email of the contact"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["mail"]}},"options":[{"name":"Send","value":"send","description":"Send an email","action":"Send an email"}],"default":"send"},{"displayName":"Sender Email","name":"fromEmail","type":"string","default":"","placeholder":"sender@domain.com","description":"Email address of the sender of the email","displayOptions":{"show":{"resource":["mail"],"operation":["send"]}}},{"displayName":"Sender Name","name":"fromName","type":"string","default":"","placeholder":"John Smith","description":"Name of the sender of the email","displayOptions":{"show":{"resource":["mail"],"operation":["send"]}}},{"displayName":"Recipient Email","name":"toEmail","type":"string","default":"","placeholder":"recipient@domain.com","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","required":true,"default":false,"description":"Whether this email will contain a dynamic template","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":"","required":true,"description":"Message body of the email to send","displayOptions":{"show":{"resource":["mail"],"operation":["send"],"dynamicTemplate":[false]}}},{"displayName":"Template Name or ID","name":"templateId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","default":[],"typeOptions":{"loadOptionsMethod":"getTemplateIds"},"displayOptions":{"show":{"resource":["mail"],"operation":["send"],"dynamicTemplate":[true]}}},{"displayName":"Dynamic Template Fields","name":"dynamicTemplateFields","placeholder":"Add Dynamic Template Fields","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"displayOptions":{"show":{"resource":["mail"],"operation":["send"],"dynamicTemplate":[true]}},"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"}]}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["mail"],"operation":["send"]}},"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":"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."}]}]

operations:
  [{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"list","name":"List"},{"type":"resource","resource":"mail","name":"Mail"},{"type":"operation","operation":"create","name":"Create","action":"Create a list","resources":["list"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a list","resources":["list"]},{"type":"operation","operation":"get","name":"Get","action":"Get a list","resources":["list"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many lists","resources":["list"]},{"type":"operation","operation":"update","name":"Update","action":"Update a list","resources":["list"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"send","name":"Send","action":"Send an email","resources":["mail"]}]


node_type: sendy
package_name: n8n-nodes-base
display_name: Sendy
description: Consume Sendy API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"sendyApi","required":true}]
updated_at: 2025-06-12 12:00:45
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","noDataExpression":true,"options":[{"name":"Campaign","value":"campaign"},{"name":"Subscriber","value":"subscriber"}],"default":"subscriber"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["campaign"]}},"options":[{"name":"Create","value":"create","description":"Create a campaign","action":"Create a campaign"}],"default":"create"},{"displayName":"From Name","name":"fromName","type":"string","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":"","description":"The 'From name' of your campaign"},{"displayName":"From Email","name":"fromEmail","type":"string","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":"","description":"The 'From email' of your campaign"},{"displayName":"Reply To","name":"replyTo","type":"string","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":"","description":"The 'Reply to' of your campaign"},{"displayName":"Title","name":"title","type":"string","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":"","description":"The 'Title' of your campaign"},{"displayName":"Subject","name":"subject","type":"string","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":"","description":"The 'Subject' of your campaign"},{"displayName":"HTML Text","name":"htmlText","type":"string","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":"","description":"The 'HTML version' of your campaign"},{"displayName":"Send Campaign","name":"sendCampaign","type":"boolean","displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"default":false,"description":"Whether to send the campaign as well and not just create a draft. Default is false."},{"displayName":"Brand ID","name":"brandId","type":"string","displayOptions":{"show":{"operation":["create"],"resource":["campaign"],"sendCampaign":[false]}},"required":true,"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["campaign"],"operation":["create"]}},"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."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["subscriber"]}},"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"}],"default":"add"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"resource":["subscriber"],"operation":["add"]}},"default":"","description":"Email address of the subscriber"},{"displayName":"List ID","name":"listId","type":"string","displayOptions":{"show":{"resource":["subscriber"],"operation":["add"]}},"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."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["subscriber"],"operation":["add"]}},"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)"}]},{"displayName":"List ID","name":"listId","type":"string","displayOptions":{"show":{"resource":["subscriber"],"operation":["count"]}},"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."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"resource":["subscriber"],"operation":["delete"]}},"default":"","description":"Email address of the subscriber"},{"displayName":"List ID","name":"listId","type":"string","displayOptions":{"show":{"resource":["subscriber"],"operation":["delete"]}},"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."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"resource":["subscriber"],"operation":["remove"]}},"default":"","description":"Email address of the subscriber"},{"displayName":"List ID","name":"listId","type":"string","displayOptions":{"show":{"resource":["subscriber"],"operation":["remove"]}},"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."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","displayOptions":{"show":{"resource":["subscriber"],"operation":["status"]}},"default":"","description":"Email address of the subscriber"},{"displayName":"List ID","name":"listId","type":"string","displayOptions":{"show":{"resource":["subscriber"],"operation":["status"]}},"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."}]

operations:
  [{"type":"resource","resource":"campaign","name":"Campaign"},{"type":"resource","resource":"subscriber","name":"Subscriber"},{"type":"operation","operation":"create","name":"Create","action":"Create a campaign","resources":["campaign"]},{"type":"operation","operation":"add","name":"Add","action":"Add a subscriber","resources":["subscriber"]},{"type":"operation","operation":"count","name":"Count","action":"Count a subscriber","resources":["subscriber"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a subscriber","resources":["subscriber"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a subscriber","resources":["subscriber"]},{"type":"operation","operation":"status","name":"Status","action":"Get subscriber's status","resources":["subscriber"]}]


node_type: sentryIo
package_name: n8n-nodes-base
display_name: Sentry.io
description: Consume Sentry.io API
category: output
development_style: programmatic
version: 1
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: 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":"Sentry Version","name":"sentryVersion","type":"options","options":[{"name":"Cloud","value":"cloud"},{"name":"Server (Self Hosted)","value":"server"}],"default":"cloud"},{"displayName":"Authentication","name":"authentication","type":"options","displayOptions":{"show":{"sentryVersion":["cloud"]}},"options":[{"name":"Access Token","value":"accessToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"accessToken"},{"displayName":"Authentication","name":"authentication","type":"options","displayOptions":{"show":{"sentryVersion":["server"]}},"options":[{"name":"Access Token","value":"accessToken"}],"default":"accessToken"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"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"}],"default":"event"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["event"]}},"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"}],"default":"get"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["event"],"operation":["getAll"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Project Slug Name or ID","name":"projectSlug","type":"options","typeOptions":{"loadOptionsMethod":"getProjects","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["event"],"operation":["getAll"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Full","name":"full","type":"boolean","default":true,"displayOptions":{"show":{"resource":["event"],"operation":["getAll"]}},"description":"Whether the event payload will include the full event body, including the stack trace"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["event"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["event"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["event"],"operation":["get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Project Slug Name or ID","name":"projectSlug","type":"options","typeOptions":{"loadOptionsMethod":"getProjects"},"default":"","displayOptions":{"show":{"resource":["event"],"operation":["get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Event ID","name":"eventId","type":"string","default":"","displayOptions":{"show":{"resource":["event"],"operation":["get"]}},"required":true,"description":"The ID of the event to retrieve (either the numeric primary-key or the hexadecimal ID as reported by the raven client)"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["issue"]}},"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"}],"default":"get"},{"displayName":"Issue ID","name":"issueId","type":"string","default":"","placeholder":"1234","displayOptions":{"show":{"resource":["issue"],"operation":["get","delete"]}},"required":true,"description":"ID of issue to get"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["issue"],"operation":["getAll"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Project Slug Name or ID","name":"projectSlug","type":"options","typeOptions":{"loadOptionsMethod":"getProjects","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["issue"],"operation":["getAll"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["issue"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["issue"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["getAll"]}},"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."}]},{"displayName":"Issue ID","name":"issueId","type":"string","default":"","placeholder":"1234","displayOptions":{"show":{"resource":["issue"],"operation":["update"]}},"required":true,"description":"ID of issue to get"},{"displayName":"Update Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["issue"],"operation":["update"]}},"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"}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["organization"]}},"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"}],"default":"get"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["organization"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["organization"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["organization"],"operation":["getAll"]}},"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"}]},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["organization"],"operation":["get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Name","name":"name","type":"string","default":"","displayOptions":{"show":{"resource":["organization"],"operation":["create"]}},"required":true,"description":"The slug of the organization the team should be created for"},{"displayName":"Agree to Terms","name":"agreeTerms","type":"boolean","default":false,"displayOptions":{"show":{"resource":["organization"],"operation":["create"]}},"description":"Whether you agree to the applicable terms of service and privacy policy of Sentry.io"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["organization"],"operation":["create"]}},"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."}]},{"displayName":"Slug Name or ID","name":"organization_slug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["organization"],"operation":["update"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["organization"],"operation":["update"]}},"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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["project"]}},"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"}],"default":"get"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["create","get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Project Slug Name or ID","name":"projectSlug","type":"options","typeOptions":{"loadOptionsMethod":"getProjects","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Team Slug Name or ID","name":"teamSlug","type":"options","typeOptions":{"loadOptionsMethod":"getTeams","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["create"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Name","name":"name","type":"string","default":"","displayOptions":{"show":{"resource":["project"],"operation":["create"]}},"required":true,"description":"The name for the new project"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["project"],"operation":["create"]}},"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."}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["project"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["project"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["update"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Project Slug Name or ID","name":"projectSlug","type":"options","typeOptions":{"loadOptionsMethod":"getProjects","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["update"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["project"],"operation":["update"]}},"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"}]},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["delete"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Project Slug Name or ID","name":"projectSlug","type":"options","typeOptions":{"loadOptionsMethod":"getProjects","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["project"],"operation":["delete"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["release"]}},"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"}],"default":"get"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["release"],"operation":["getAll"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["release"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["release"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["release"],"operation":["getAll"]}},"options":[{"displayName":"Query","name":"query","type":"string","default":"","description":"This parameter can be used to create a “starts with” filter for the version"}]},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["release"],"operation":["get","delete"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Version","name":"version","type":"string","default":"","displayOptions":{"show":{"resource":["release"],"operation":["get","delete"]}},"required":true,"description":"The version identifier of the release"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["release"],"operation":["create"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Version","name":"version","type":"string","default":"","displayOptions":{"show":{"resource":["release"],"operation":["create"]}},"required":true,"description":"A version identifier for this release. Can be a version number, a commit hash etc."},{"displayName":"URL","name":"url","type":"string","default":"","displayOptions":{"show":{"resource":["release"],"operation":["create"]}},"required":true,"description":"A URL that points to the release. This can be the path to an online interface to the sourcecode for instance."},{"displayName":"Project Names or IDs","name":"projects","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getProjects"},"default":[],"displayOptions":{"show":{"resource":["release"],"operation":["create"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["release"],"operation":["create"]}},"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"}]}]}]},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["release"],"operation":["update"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Version","name":"version","type":"string","default":"","displayOptions":{"show":{"resource":["release"],"operation":["update"]}},"required":true,"description":"A version identifier for this release. Can be a version number, a commit hash etc."},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["release"],"operation":["update"]}},"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."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["team"]}},"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"}],"default":"get"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["getAll"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["team"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["team"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Team Slug Name or ID","name":"teamSlug","type":"options","typeOptions":{"loadOptionsMethod":"getTeams","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Name","name":"name","type":"string","default":"","displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"required":true,"description":"The name of the team"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["team"],"operation":["create"]}},"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."}]},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["update"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Team Slug Name or ID","name":"teamSlug","type":"options","typeOptions":{"loadOptionsMethod":"getTeams","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["update"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["team"],"operation":["update"]}},"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."}]},{"displayName":"Organization Slug Name or ID","name":"organizationSlug","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizations"},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["delete"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Team Slug Name or ID","name":"teamSlug","type":"options","typeOptions":{"loadOptionsMethod":"getTeams","loadOptionsDependsOn":["organizationSlug"]},"default":"","displayOptions":{"show":{"resource":["team"],"operation":["delete"]}},"required":true,"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-examples/expressions/\">expression</a>."}]

operations:
  [{"type":"resource","resource":"event","name":"Event"},{"type":"resource","resource":"issue","name":"Issue"},{"type":"resource","resource":"organization","name":"Organization"},{"type":"resource","resource":"project","name":"Project"},{"type":"resource","resource":"release","name":"Release"},{"type":"resource","resource":"team","name":"Team"},{"type":"operation","operation":"get","name":"Get","action":"Get an event","resources":["event"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many events","resources":["event"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an issue","resources":["issue"]},{"type":"operation","operation":"get","name":"Get","action":"Get an issue","resources":["issue"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many issues","resources":["issue"]},{"type":"operation","operation":"update","name":"Update","action":"Update an issue","resources":["issue"]},{"type":"operation","operation":"create","name":"Create","action":"Create an organization","resources":["organization"]},{"type":"operation","operation":"get","name":"Get","action":"Get an organization","resources":["organization"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many organizations","resources":["organization"]},{"type":"operation","operation":"update","name":"Update","action":"Update an organization","resources":["organization"]},{"type":"operation","operation":"create","name":"Create","action":"Create a project","resources":["project"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a project","resources":["project"]},{"type":"operation","operation":"get","name":"Get","action":"Get a project","resources":["project"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many projects","resources":["project"]},{"type":"operation","operation":"update","name":"Update","action":"Update a project","resources":["project"]},{"type":"operation","operation":"create","name":"Create","action":"Create a release","resources":["release"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a release","resources":["release"]},{"type":"operation","operation":"get","name":"Get","action":"Get a release by version ID","resources":["release"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many releases","resources":["release"]},{"type":"operation","operation":"update","name":"Update","action":"Update a release","resources":["release"]},{"type":"operation","operation":"create","name":"Create","action":"Create a team","resources":["team"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a team","resources":["team"]},{"type":"operation","operation":"get","name":"Get","action":"Get a team","resources":["team"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many teams","resources":["team"]},{"type":"operation","operation":"update","name":"Update","action":"Update a team","resources":["team"]}]

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


node_type: serviceNow
package_name: n8n-nodes-base
display_name: ServiceNow
description: Consume ServiceNow API
category: output
development_style: programmatic
version: 1
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: 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":"Authentication","name":"authentication","type":"options","options":[{"name":"Basic Auth","value":"basicAuth"},{"name":"OAuth2","value":"oAuth2"}],"default":"oAuth2","description":"Authentication method to use"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"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"}],"default":"user"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["attachment"]}},"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"}],"default":"upload"},{"displayName":"Table Name or ID","name":"tableName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTables"},"default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["upload","getAll"]}},"required":true},{"displayName":"Table Record ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["upload"]}},"required":true,"description":"Sys_id of the record in the table specified in Table Name that you want to attach the file to"},{"displayName":"Input Data Field Name","name":"inputDataFieldName","type":"string","default":"data","required":true,"displayOptions":{"show":{"resource":["attachment"],"operation":["upload"]}},"description":"Name of the binary property that contains the data to upload"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["attachment"],"operation":["upload"]}},"default":{},"options":[{"displayName":"File Name for the Attachment","name":"file_name","type":"string","default":"","description":"Name to give the attachment"}]},{"displayName":"Attachment ID","name":"attachmentId","type":"string","default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["delete"]}},"required":true,"description":"Sys_id value of the attachment to delete"},{"displayName":"Attachment ID","name":"attachmentId","type":"string","default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["get"]}},"required":true,"description":"Sys_id value of the attachment to delete"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["attachment"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["attachment"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"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","placeholder":"Add Field","displayOptions":{"show":{"resource":["attachment"],"operation":["get","getAll"]}},"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>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["businessService"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many business services"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["businessService"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["businessService"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["businessService"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["configurationItems"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many configuration items"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["configurationItems"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["configurationItems"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["configurationItems"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["department"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many departments"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["department"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["department"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["department"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["dictionary"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many dictionaries"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["dictionary"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["dictionary"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["dictionary"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["incident"]}},"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"}],"default":"get"},{"displayName":"Short Description","name":"short_description","type":"string","default":"","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"required":true,"description":"Short description of the incident"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["incident"],"operation":["create"]}},"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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["incident"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["incident"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","displayOptions":{"show":{"resource":["incident"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Incident ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["incident"],"operation":["delete","get"]}},"required":true,"description":"Unique identifier of the incident"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","displayOptions":{"show":{"resource":["incident"],"operation":["get"]}},"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-examples/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"}]},{"displayName":"Incident ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["incident"],"operation":["update"]}},"required":true,"description":"Unique identifier of the incident"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["incident"],"operation":["update"]}},"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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["tableRecord"]}},"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"}],"default":"get"},{"displayName":"Table Name or ID","name":"tableName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTables"},"default":"","displayOptions":{"show":{"resource":["tableRecord"],"operation":["create"]}},"required":true},{"displayName":"Data to Send","name":"dataToSend","type":"options","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"]}},"default":"columns"},{"displayName":"Inputs to Ignore","name":"inputsToIgnore","type":"string","displayOptions":{"show":{"resource":["tableRecord"],"operation":["create"],"dataToSend":["mapInput"]}},"default":"","description":"List of input properties to avoid sending, separated by commas. Leave empty to send all inputs."},{"displayName":"Fields to Send","name":"fieldsToSend","type":"fixedCollection","placeholder":"Add field to send","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["tableRecord"],"operation":["create"],"dataToSend":["columns"]}},"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-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getColumns","loadOptionsDependsOn":["tableName"]},"default":""},{"displayName":"Field Value","name":"value","type":"string","default":""}]}]},{"displayName":"Table Name or ID","name":"tableName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTables"},"default":"","displayOptions":{"show":{"resource":["tableRecord"],"operation":["getAll"]}},"required":true},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["tableRecord"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["tableRecord"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["tableRecord"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Table Name or ID","name":"tableName","type":"options","typeOptions":{"loadOptionsMethod":"getTables"},"default":"","displayOptions":{"show":{"resource":["tableRecord"],"operation":["delete","get"]}},"required":true,"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-examples/expressions/\">expression</a>."},{"displayName":"Table Record ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["tableRecord"],"operation":["delete","get"]}},"required":true,"description":"Unique identifier of the record"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["tableRecord"],"operation":["get"]}},"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-examples/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"}]},{"displayName":"Table Name or ID","name":"tableName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getTables"},"default":"","displayOptions":{"show":{"resource":["tableRecord"],"operation":["update"]}},"required":true},{"displayName":"Table Record ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["tableRecord"],"operation":["update"]}},"required":true,"description":"Unique identifier of the record"},{"displayName":"Data to Send","name":"dataToSend","type":"options","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"]}},"default":"columns"},{"displayName":"Inputs to Ignore","name":"inputsToIgnore","type":"string","displayOptions":{"show":{"resource":["tableRecord"],"operation":["update"],"dataToSend":["mapInput"]}},"default":"","description":"List of input properties to avoid sending, separated by commas. Leave empty to send all inputs."},{"displayName":"Fields to Send","name":"fieldsToSend","type":"fixedCollection","placeholder":"Add field to send","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["tableRecord"],"operation":["update"],"dataToSend":["columns"]}},"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-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getColumns","loadOptionsDependsOn":["tableName"]},"default":""},{"displayName":"Field Value","name":"value","type":"string","default":""}]}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"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"}],"default":"get"},{"displayName":"Short Description","name":"short_description","type":"string","default":"","displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"required":true,"description":"Short description of the user"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["user"],"operation":["create"]}},"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-examples/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"}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["user"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["user"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Retrieve Identifier","name":"getOption","type":"options","default":"id","options":[{"name":"ID","value":"id"},{"name":"Username","value":"user_name"}],"displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"required":true,"description":"Unique identifier of the user"},{"displayName":"Username","name":"user_name","type":"string","default":"","displayOptions":{"show":{"resource":["user"],"operation":["get"],"getOption":["user_name"]}},"required":true,"description":"Unique identifier of the user"},{"displayName":"User ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["user"],"operation":["get"],"getOption":["id"]}},"required":true,"description":"Unique identifier of the user"},{"displayName":"User ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["user"],"operation":["delete"]}},"required":true,"description":"Unique identifier of the user"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"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-examples/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"}]},{"displayName":"User ID","name":"id","type":"string","default":"","displayOptions":{"show":{"resource":["user"],"operation":["update"]}},"required":true,"description":"Unique identifier of the user"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["user"],"operation":["update"]}},"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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["userGroup"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many user groups"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["userGroup"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["userGroup"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["userGroup"],"operation":["getAll"]}},"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-examples/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"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["userRole"]}},"options":[{"name":"Get Many","value":"getAll","action":"Get many user roles"}],"default":"getAll"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["userRole"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["userRole"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["userRole"],"operation":["getAll"]}},"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-examples/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"}]}]

operations:
  [{"type":"resource","resource":"attachment","name":"Attachment"},{"type":"resource","resource":"businessService","name":"Business Service"},{"type":"resource","resource":"configurationItems","name":"Configuration Item"},{"type":"resource","resource":"department","name":"Department"},{"type":"resource","resource":"dictionary","name":"Dictionary"},{"type":"resource","resource":"incident","name":"Incident"},{"type":"resource","resource":"tableRecord","name":"Table Record"},{"type":"resource","resource":"user","name":"User"},{"type":"resource","resource":"userGroup","name":"User Group"},{"type":"resource","resource":"userRole","name":"User Role"},{"type":"operation","operation":"upload","name":"Upload","action":"Upload an attachment","resources":["attachment"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an attachment","resources":["attachment"]},{"type":"operation","operation":"get","name":"Get","action":"Get an attachment","resources":["attachment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many attachments","resources":["attachment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many business services","resources":["businessService"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many configuration items","resources":["configurationItems"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many departments","resources":["department"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many dictionaries","resources":["dictionary"]},{"type":"operation","operation":"create","name":"Create","action":"Create an incident","resources":["incident"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an incident","resources":["incident"]},{"type":"operation","operation":"get","name":"Get","action":"Get an incident","resources":["incident"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many incidents","resources":["incident"]},{"type":"operation","operation":"update","name":"Update","action":"Update an incident","resources":["incident"]},{"type":"operation","operation":"create","name":"Create","action":"Create a table record","resources":["tableRecord"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a table record","resources":["tableRecord"]},{"type":"operation","operation":"get","name":"Get","action":"Get a table record","resources":["tableRecord"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many table records","resources":["tableRecord"]},{"type":"operation","operation":"update","name":"Update","action":"Update a table record","resources":["tableRecord"]},{"type":"operation","operation":"create","name":"Create","action":"Create a user","resources":["user"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a user","resources":["user"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]},{"type":"operation","operation":"update","name":"Update","action":"Update a user","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many user groups","resources":["userGroup"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many user roles","resources":["userRole"]}]

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


node_type: set
package_name: n8n-nodes-base
display_name: Set
description: Add or edit fields on an input item and optionally remove other fields
category: input
development_style: programmatic
version: 1
properties_schema: []
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Edit Fields (Set)
  description: Documentation for the Edit Fields node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  ---

  # Edit Fields (Set)

  Use the Edit Fields node to set workflow data. This node can set new data as well as overwrite data that already exists. This node is crucial in workflows which expect incoming data from previous nodes, such as when inserting values to Google Sheets or databases.

  ## Node parameters

  These are the settings and options available in the Edit Fields node.

  ### Mode

  You can either use **Manual Mapping** to edit fields using the GUI or **JSON Output** to write JSON that n8n adds to the input data.

  ### Fields to Set

  If you select **Mode** > **Manual Mapping**, you can configure the fields by dragging and dropping values from **INPUT**.

  The default behavior when you drag a value is:

  * n8n sets the value's name as the field name.
  * The field value contains an expression which accesses the value.

  If you don't want to use expressions:

  1. Hover over a field. n8n displays the **Fixed | Expressions** toggle. 
  1. Select **Fixed**.

  You can do this for both the name and value of the field.

  ![A gif showing the drag and drop action, as well as changing a field to fixed](/_images/integrations/builtin/core-nodes/set/drag-drop-fixed-toggle.gif)

  ### Keep Only Set Fields

  Enable this to discard any input data that you don't use in **Fields to Set**.

  ### Include in Output

  Choose which input data to include in the node's output data.

  ## Node options

  Use these options to customize the behavior of the node.

  ### Include Binary Data

  If the input data includes binary data, choose whether to include it in the Edit Fields node's output data.

  ### Ignore Type Conversion Errors

  Manual Mapping only.

  Enabling this allows n8n to ignore some data type errors when mapping fields.

  ### Support Dot Notation

  By default, n8n supports dot notation.

  For example, when using manual mapping, the node follows the dot notation for the **Name** field. That means if you set the name in the **Name** field as `number.one` and the value in the **Value** field as `20`, the resulting JSON is:

  ```json
  { "number": { "one": 20} }
  ```

  You can prevent this behavior by selecting **Add Option** > **Support Dot Notation**, and setting the **Dot Notion** field to off. Now the resulting JSON is:

  ```json
  { "number.one": 20 }
  ```
  ## Templates and examples

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

  ## Arrays and expressions in JSON Output mode

  You can use arrays and expressions when creating your JSON Output.

  For example, given this input data generated by the Customer Datastore node:

  ```json
  [
    {
      "id": "23423532",
      "name": "Jay Gatsby",
      "email": "gatsby@west-egg.com",
      "notes": "Keeps asking about a green light??",
      "country": "US",
      "created": "1925-04-10"
    },
    {
      "id": "23423533",
      "name": "José Arcadio Buendía",
      "email": "jab@macondo.co",
      "notes": "Lots of people named after him. Very confusing",
      "country": "CO",
      "created": "1967-05-05"
    },
    {
      "id": "23423534",
      "name": "Max Sendak",
      "email": "info@in-and-out-of-weeks.org",
      "notes": "Keeps rolling his terrible eyes",
      "country": "US",
      "created": "1963-04-09"
    },
    {
      "id": "23423535",
      "name": "Zaphod Beeblebrox",
      "email": "captain@heartofgold.com",
      "notes": "Felt like I was talking to more than one person",
      "country": null,
      "created": "1979-10-12"
    },
    {
      "id": "23423536",
      "name": "Edmund Pevensie",
      "email": "edmund@narnia.gov",
      "notes": "Passionate sailor",
      "country": "UK",
      "created": "1950-10-16"
    }
  ]
  ```

  Add the following JSON in the **JSON Output** field, with **Include in Output** set to **All Input Fields**:

  ```json
  {
    "newKey": "new value",
    "array": [{{ $json.id }},"{{ $json.name }}"],
    "object": {
      "innerKey1": "new value",
      "innerKey2": "{{ $json.id }}",
      "innerKey3": "{{ $json.name }}",
   }
  }
  ```

  You get this output:

  ```json
  [
    {
      "id": "23423532",
      "name": "Jay Gatsby",
      "email": "gatsby@west-egg.com",
      "notes": "Keeps asking about a green light??",
      "country": "US",
      "created": "1925-04-10",
      "newKey": "new value",
      "array": [
        23423532,
        "Jay Gatsby"
      ],
      "object": {
        "innerKey1": "new value",
        "innerKey2": "23423532",
        "innerKey3": "Jay Gatsby"
      }
    },
    {
      "id": "23423533",
      "name": "José Arcadio Buendía",
      "email": "jab@macondo.co",
      "notes": "Lots of people named after him. Very confusing",
      "country": "CO",
      "created": "1967-05-05",
      "newKey": "new value",
      "array": [
        23423533,
        "José Arcadio Buendía"
      ],
      "object": {
        "innerKey1": "new value",
        "innerKey2": "23423533",
        "innerKey3": "José Arcadio Buendía"
      }
    },
    {
      "id": "23423534",
      "name": "Max Sendak",
      "email": "info@in-and-out-of-weeks.org",
      "notes": "Keeps rolling his terrible eyes",
      "country": "US",
      "created": "1963-04-09",
      "newKey": "new value",
      "array": [
        23423534,
        "Max Sendak"
      ],
      "object": {
        "innerKey1": "new value",
        "innerKey2": "23423534",
        "innerKey3": "Max Sendak"
      }
    },
    {
      "id": "23423535",
      "name": "Zaphod Beeblebrox",
      "email": "captain@heartofgold.com",
      "notes": "Felt like I was talking to more than one person",
      "country": null,
      "created": "1979-10-12",
      "newKey": "new value",
      "array": [
        23423535,
        "Zaphod Beeblebrox"
      ],
      "object": {
        "innerKey1": "new value",
        "innerKey2": "23423535",
        "innerKey3": "Zaphod Beeblebrox"
      }
    },
    {
      "id": "23423536",
      "name": "Edmund Pevensie",
      "email": "edmund@narnia.gov",
      "notes": "Passionate sailor",
      "country": "UK",
      "created": "1950-10-16",
      "newKey": "new value",
      "array": [
        23423536,
        "Edmund Pevensie"
      ],
      "object": {
        "innerKey1": "new value",
        "innerKey2": "23423536",
        "innerKey3": "Edmund Pevensie"
      }
    }
  ]
  ```


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

  # Shopify node

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

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

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

  ## Operations

  * Order
      * Create an order
      * Delete an order
      * Get an order
      * Get all orders
      * Update an order
  * Product
      * Create a product
      * Delete a product
      * Get a product
      * Get all products
      * Update a product

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"Access Token","value":"accessToken"},{"name":"OAuth2","value":"oAuth2"},{"name":"API Key","value":"apiKey"}],"default":"apiKey"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Order","value":"order"},{"name":"Product","value":"product"}],"default":"order"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["order"]}},"options":[{"name":"Create","value":"create","description":"Create an order","action":"Create an order"},{"name":"Delete","value":"delete","description":"Delete an order","action":"Delete an order"},{"name":"Get","value":"get","description":"Get an order","action":"Get an order"},{"name":"Get Many","value":"getAll","description":"Get many orders","action":"Get many orders"},{"name":"Update","value":"update","description":"Update an order","action":"Update an order"}],"default":"create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["order"]}},"default":{},"options":[{"displayName":"Billing Address","name":"billingAddressUi","placeholder":"Add Billing Address","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":false},"options":[{"name":"billingAddressValues","displayName":"Billing Address","values":[{"displayName":"First Name","name":"firstName","type":"string","default":""},{"displayName":"Last Name","name":"lastName","type":"string","default":""},{"displayName":"Company","name":"company","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":""},{"displayName":"Address Line 1","name":"address1","type":"string","default":""},{"displayName":"Address Line 2","name":"address2","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"Province","name":"province","type":"string","default":""},{"displayName":"Zip Code","name":"zip","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""}]}]},{"displayName":"Discount Codes","name":"discountCodesUi","placeholder":"Add Discount Code","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"options":[{"name":"discountCodesValues","displayName":"Discount Code","values":[{"displayName":"Amount","name":"amount","type":"string","default":"","description":"The amount that's deducted from the order total"},{"displayName":"Code","name":"code","type":"string","default":"","description":"When the associated discount application is of type code"},{"displayName":"Type","name":"type","type":"options","options":[{"name":"Fixed Amount","value":"fixedAmount","description":"Applies amount as a unit of the store's currency"},{"name":"Percentage","value":"percentage","description":"Applies a discount of amount as a percentage of the order total"},{"name":"Shipping","value":"shipping","description":"Applies a free shipping discount on orders that have a shipping rate less than or equal to amount"}],"default":"fixedAmount","description":"When the associated discount application is of type code"}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The customer's email address"},{"displayName":"Fulfillment Status","name":"fulfillmentStatus","type":"options","options":[{"name":"Fulfilled","value":"fulfilled","description":"Every line item in the order has been fulfilled"},{"name":"Null","value":"null","description":"None of the line items in the order have been fulfilled"},{"name":"Partial","value":"partial","description":"At least one line item in the order has been fulfilled"},{"name":"Restocked","value":"restocked","description":"Every line item in the order has been restocked and the order canceled"}],"default":"","description":"The order's status in terms of fulfilled line items"},{"displayName":"Inventory Behaviour","name":"inventoryBehaviour","type":"options","options":[{"name":"Bypass","value":"bypass","description":"Do not claim inventory"},{"name":"Decrement Ignoring Policy","value":"decrementIgnoringPolicy","description":"Ignore the product's inventory policy and claim inventory"},{"name":"Decrement Obeying Policy","value":"decrementObeyingPolicy","description":"Follow the product's inventory policy and claim inventory, if possible"}],"default":"bypass","description":"The behaviour to use when updating inventory"},{"displayName":"Location Name or ID","name":"locationId","type":"options","typeOptions":{"loadOptionsMethod":"getLocations"},"default":"","description":"The ID of the physical location where the order was processed. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Note","name":"note","type":"string","default":"","description":"An optional note that a shop owner can attach to the order"},{"displayName":"Send Fulfillment Receipt","name":"sendFulfillmentReceipt","type":"boolean","default":false,"description":"Whether to send a shipping confirmation to the customer"},{"displayName":"Send Receipt","name":"sendReceipt","type":"boolean","default":false,"description":"Whether to send an order confirmation to the customer"},{"displayName":"Shipping Address","name":"shippingAddressUi","placeholder":"Add Shipping","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":false},"options":[{"name":"shippingAddressValues","displayName":"Shipping Address","values":[{"displayName":"First Name","name":"firstName","type":"string","default":""},{"displayName":"Last Name","name":"lastName","type":"string","default":""},{"displayName":"Company","name":"company","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":""},{"displayName":"Address Line 1","name":"address1","type":"string","default":""},{"displayName":"Address Line 2","name":"address2","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"Province","name":"province","type":"string","default":""},{"displayName":"Zip Code","name":"zip","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""}]}]},{"displayName":"Source Name","name":"sourceName","type":"string","default":"","description":"Where the order originated. Can be set only during order creation, and is not writeable afterwards."},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"Tags attached to the order, formatted as a string of comma-separated values"},{"displayName":"Test","name":"test","type":"boolean","default":false,"description":"Whether this is a test order"}]},{"displayName":"Line Items","name":"limeItemsUi","placeholder":"Add Line Item","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["order"],"operation":["create"]}},"default":{},"options":[{"displayName":"Line Item","name":"lineItemValues","values":[{"displayName":"Product Name or ID","name":"productId","type":"options","typeOptions":{"loadOptionsMethod":"getProducts"},"default":"","description":"The ID of the product that the line item belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Variant ID","name":"variantId","type":"string","default":"","description":"The ID of the product variant"},{"displayName":"Title","name":"title","type":"string","default":"","description":"The title of the product"},{"displayName":"Grams","name":"grams","type":"string","default":"","description":"The weight of the item in grams"},{"displayName":"Quantity","name":"quantity","type":"number","typeOptions":{"minValue":1},"default":1,"description":"The number of items that were purchased"},{"displayName":"Price","name":"price","type":"string","default":""}]}]},{"displayName":"Order ID","name":"orderId","type":"string","default":"","displayOptions":{"show":{"resource":["order"],"operation":["delete"]}},"required":true},{"displayName":"Order ID","name":"orderId","type":"string","default":"","displayOptions":{"show":{"resource":["order"],"operation":["get"]}},"required":true},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["get"],"resource":["order"]}},"default":{},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields the order will return, formatted as a string of comma-separated values. By default all the fields are returned."}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["order"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["order"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":250},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["order"]}},"options":[{"displayName":"Attribution App ID","name":"attributionAppId","type":"string","default":"","description":"Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API."},{"displayName":"Created At Min","name":"createdAtMin","type":"dateTime","default":"","description":"Show orders created at or after date"},{"displayName":"Created At Max","name":"createdAtMax","type":"dateTime","default":"","description":"Show orders created at or before date"},{"displayName":"Financial Status","name":"financialStatus","type":"options","options":[{"name":"Any","value":"any","description":"Show orders of any financial status"},{"name":"Authorized","value":"authorized","description":"Show only authorized orders"},{"name":"Paid","value":"paid","description":"Show only paid orders"},{"name":"Partially Paid","value":"partiallyPaid","description":"Show only partially paid orders"},{"name":"Partially Refunded","value":"partiallyRefunded","description":"Show only partially refunded orders"},{"name":"Pending","value":"pending","description":"Show only pending orders"},{"name":"Refunded","value":"refunded","description":"Show only refunded orders"},{"name":"Unpaid","value":"unpaid","description":"Show authorized and partially paid orders"},{"name":"Voided","value":"voided","description":"Show only voided orders"}],"default":"any","description":"Filter orders by their financial status"},{"displayName":"Fulfillment Status","name":"fulfillmentStatus","type":"options","options":[{"name":"Any","value":"any","description":"Show orders of any fulfillment status"},{"name":"Partial","value":"partial","description":"Show partially shipped orders"},{"name":"Shipped","value":"shipped","description":"Show orders that have been shipped. Returns orders with fulfillment_status of fulfilled."},{"name":"Unfulfilled","value":"unfulfilled","description":"Returns orders with fulfillment_status of null or partial"},{"name":"Unshipped","value":"unshipped","description":"Show orders that have not yet been shipped. Returns orders with fulfillment_status of null."}],"default":"any","description":"Filter orders by their fulfillment status"},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields the orders will return, formatted as a string of comma-separated values. By default all the fields are returned."},{"displayName":"IDs","name":"ids","type":"string","default":"","description":"Retrieve only orders specified by a comma-separated list of order IDs"},{"displayName":"Processed At Max","name":"processedAtMax","type":"dateTime","default":"","description":"Show orders imported at or before date"},{"displayName":"Processed At Min","name":"processedAtMin","type":"dateTime","default":"","description":"Show orders imported at or after date"},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Any","value":"any","description":"Show orders of any status, including archived orders"},{"name":"Cancelled","value":"Cancelled","description":"Show only canceled orders"},{"name":"Closed","value":"closed","description":"Show only closed orders"},{"name":"Open","value":"open","description":"Show only open orders"}],"default":"open","description":"Filter orders by their status"},{"displayName":"Since ID","name":"sinceId","type":"string","default":"","description":"Show orders after the specified ID"},{"displayName":"Updated At Max","name":"updatedAtMax","type":"dateTime","default":"","description":"Show orders last updated at or after date"},{"displayName":"Updated At Min","name":"updatedAtMin","type":"dateTime","default":"","description":"Show orders last updated at or before date"}]},{"displayName":"Order ID","name":"orderId","type":"string","default":"","displayOptions":{"show":{"resource":["order"],"operation":["update"]}},"required":true},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["order"]}},"default":{},"options":[{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"The customer's email address"},{"displayName":"Location Name or ID","name":"locationId","type":"options","typeOptions":{"loadOptionsMethod":"getLocations"},"default":"","description":"The ID of the physical location where the order was processed. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Note","name":"note","type":"string","default":"","description":"An optional note that a shop owner can attach to the order"},{"displayName":"Shipping Address","name":"shippingAddressUi","placeholder":"Add Shipping","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":false},"options":[{"name":"shippingAddressValues","displayName":"Shipping Address","values":[{"displayName":"First Name","name":"firstName","type":"string","default":""},{"displayName":"Last Name","name":"lastName","type":"string","default":""},{"displayName":"Company","name":"company","type":"string","default":""},{"displayName":"Country","name":"country","type":"string","default":""},{"displayName":"Address Line 1","name":"address1","type":"string","default":""},{"displayName":"Address Line 2","name":"address2","type":"string","default":""},{"displayName":"City","name":"city","type":"string","default":""},{"displayName":"Province","name":"province","type":"string","default":""},{"displayName":"Zip Code","name":"zip","type":"string","default":""},{"displayName":"Phone","name":"phone","type":"string","default":""}]}]},{"displayName":"Source Name","name":"sourceName","type":"string","default":"","description":"Where the order originated. Can be set only during order creation, and is not writeable afterwards."},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"Tags attached to the order, formatted as a string of comma-separated values"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["product"]}},"options":[{"name":"Create","value":"create","description":"Create a product","action":"Create a product"},{"name":"Delete","value":"delete","description":"Delete a product","action":"Delete a product"},{"name":"Get","value":"get","description":"Get a product","action":"Get a product"},{"name":"Get Many","value":"getAll","description":"Get many products","action":"Get many products"},{"name":"Update","value":"update","description":"Update a product","action":"Update a product"}],"default":"create"},{"displayName":"Title","name":"title","type":"string","placeholder":"","displayOptions":{"show":{"operation":["create"],"resource":["product"]}},"default":"","description":"The name of the product","required":true},{"displayName":"Product ID","name":"productId","type":"string","default":"","displayOptions":{"show":{"resource":["product"],"operation":["update"]}},"required":true},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["product"]}},"default":{},"options":[{"displayName":"Body HTML","name":"body_html","type":"string","default":"","description":"A description of the product. Supports HTML formatting."},{"displayName":"Handle","name":"handle","type":"string","default":"","description":"A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects."},{"displayName":"Images","name":"images","type":"collection","placeholder":"Add Image Field","typeOptions":{"multipleValues":true},"default":{},"description":"A list of product image objects, each one representing an image associated with the product","options":[{"displayName":"Created At","name":"created_at","type":"dateTime","default":"","description":"The date and time when the product image was created"},{"displayName":"ID","name":"id","type":"number","default":"","description":"A unique numeric identifier for the product image"},{"displayName":"Position","name":"position","type":"number","default":"","description":"The order of the product image in the list. The first product image is at position 1 and is the \"main\" image for the product."},{"displayName":"Product ID","name":"product_id","type":"number","default":"","description":"The ID of the product associated with the image"},{"displayName":"Variant IDs","name":"variant_ids","type":"number","typeOptions":{"multipleValues":true},"default":"","description":"An array of variant IDs associated with the image"},{"displayName":"Source","name":"src","type":"string","default":"","description":"<p>Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image.</p><p>For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).</p>."},{"displayName":"Width","name":"width","type":"number","default":"","description":"Width dimension of the image which is determined on upload"},{"displayName":"Height","name":"height","type":"number","default":"","description":"Height dimension of the image which is determined on upload"},{"displayName":"Updated At","name":"updated_at","type":"dateTime","default":"","description":"The date and time when the product image was last modified"}]},{"displayName":"Options","name":"productOptions","type":"fixedCollection","placeholder":"Add Option","typeOptions":{"multipleValues":true},"default":{},"description":"The custom product property names like Size, Color, and Material. You can add up to 3 options of up to 255 characters each.","options":[{"displayName":"Option","name":"option","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Option's name"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Option's values"}]}]},{"displayName":"Product Type","name":"product_type","type":"string","default":"","description":"A categorization for the product used for filtering and searching products"},{"displayName":"Published At","name":"published_at","type":"dateTime","default":"","description":"The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel."},{"displayName":"Published Scope","name":"published_scope","type":"options","default":"","options":[{"name":"Global","value":"global","description":"The product is published to both the Online Store channel and the Point of Sale channel"},{"name":"Web","value":"web","description":"The product is published to the Online Store channel but not published to the Point of Sale channel"}]},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters."},{"displayName":"Template Suffix","name":"template_suffix","type":"string","default":"","description":"The suffix of the Liquid template used for the product page. If this property is specified, then the product page uses a template called \"product.suffix.liquid\", where \"suffix\" is the value of this property. If this property is \"\" or null, then the product page uses the default template \"product.liquid\". (default: null)"},{"displayName":"Vendor","name":"vendor","type":"string","default":"","description":"The name of the product's vendor"}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["product"]}},"default":{},"options":[{"displayName":"Body HTML","name":"body_html","type":"string","default":"","description":"A description of the product. Supports HTML formatting."},{"displayName":"Handle","name":"handle","type":"string","default":"","description":"A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects."},{"displayName":"Images","name":"images","type":"collection","placeholder":"Add Image Field","typeOptions":{"multipleValues":true},"default":{},"description":"A list of product image objects, each one representing an image associated with the product","options":[{"displayName":"Created At","name":"created_at","type":"dateTime","default":"","description":"The date and time when the product image was created"},{"displayName":"ID","name":"id","type":"number","default":"","description":"A unique numeric identifier for the product image"},{"displayName":"Position","name":"position","type":"number","default":"","description":"The order of the product image in the list. The first product image is at position 1 and is the \"main\" image for the product."},{"displayName":"Product ID","name":"product_id","type":"number","default":"","description":"The ID of the product associated with the image"},{"displayName":"Variant IDs","name":"variant_ids","type":"number","typeOptions":{"multipleValues":true},"default":"","description":"An array of variant IDs associated with the image"},{"displayName":"Source","name":"src","type":"string","default":"","description":"<p>Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image.</p><p>For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).</p>."},{"displayName":"Width","name":"width","type":"number","default":"","description":"Width dimension of the image which is determined on upload"},{"displayName":"Height","name":"height","type":"number","default":"","description":"Height dimension of the image which is determined on upload"},{"displayName":"Updated At","name":"updated_at","type":"dateTime","default":"","description":"The date and time when the product image was last modified"}]},{"displayName":"Options","name":"productOptions","type":"fixedCollection","placeholder":"Add Option","typeOptions":{"multipleValues":true},"default":{},"description":"The custom product property names like Size, Color, and Material. You can add up to 3 options of up to 255 characters each.","options":[{"displayName":"Option","name":"option","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Option's name"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Option's values"}]}]},{"displayName":"Product Type","name":"product_type","type":"string","default":"","description":"A categorization for the product used for filtering and searching products"},{"displayName":"Published At","name":"published_at","type":"dateTime","default":"","description":"The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel."},{"displayName":"Published Scope","name":"published_scope","type":"options","default":"","options":[{"name":"Global","value":"global","description":"The product is published to both the Online Store channel and the Point of Sale channel"},{"name":"Web","value":"web","description":"The product is published to the Online Store channel but not published to the Point of Sale channel"}]},{"displayName":"Tags","name":"tags","type":"string","default":"","description":"A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters."},{"displayName":"Template Suffix","name":"template_suffix","type":"string","default":"","description":"The suffix of the Liquid template used for the product page. If this property is specified, then the product page uses a template called \"product.suffix.liquid\", where \"suffix\" is the value of this property. If this property is \"\" or null, then the product page uses the default template \"product.liquid\". (default: null)"},{"displayName":"Title","name":"title","type":"string","default":"","description":"The name of the product"},{"displayName":"Vendor","name":"vendor","type":"string","default":"","description":"The name of the product's vendor"}]},{"displayName":"Product ID","name":"productId","type":"string","default":"","displayOptions":{"show":{"resource":["product"],"operation":["delete"]}},"required":true},{"displayName":"Product ID","name":"productId","type":"string","default":"","displayOptions":{"show":{"resource":["product"],"operation":["get"]}},"required":true},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["get"],"resource":["product"]}},"default":{},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields the product will return, formatted as a string of comma-separated values. By default all the fields are returned."}]},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["product"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["product"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":250},"default":50,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["getAll"],"resource":["product"]}},"options":[{"displayName":"Collection ID","name":"collection_id","type":"string","default":"","description":"Filter results by product collection ID"},{"displayName":"Created At Max","name":"created_at_max","type":"dateTime","default":"","description":"Show products created before date"},{"displayName":"Created At Min","name":"created_at_min","type":"dateTime","default":"","description":"Show products created after date"},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Show only certain fields, specified by a comma-separated list of field names"},{"displayName":"Handle","name":"handle","type":"string","default":"","description":"Filter results by product handle"},{"displayName":"IDs","name":"ids","type":"string","default":"","description":"Return only products specified by a comma-separated list of product IDs"},{"displayName":"Presentment Currencies","name":"presentment_currencies","type":"string","default":"","description":"Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes"},{"displayName":"Product Type","name":"product_type","type":"string","default":"","description":"Filter results by product type"},{"displayName":"Published At Max","name":"published_at_max","type":"dateTime","default":"","description":"Show products published before date"},{"displayName":"Published At Min","name":"published_at_min","type":"dateTime","default":"","description":"Show products published after date"},{"displayName":"Published Status","name":"published_status","type":"options","options":[{"name":"Any","value":"any","description":"Show all products"},{"name":"Published","value":"published","description":"Show only published products"},{"name":"Unpublished","value":"unpublished","description":"Show only unpublished products"}],"default":"any","description":"Return products by their published status"},{"displayName":"Title","name":"title","type":"string","default":"","description":"Filter results by product title"},{"displayName":"Updated At Max","name":"updated_at_max","type":"dateTime","default":"","description":"Show products last updated before date"},{"displayName":"Updated At Min","name":"updated_at_min","type":"dateTime","default":"","description":"Show products last updated after date"},{"displayName":"Vendor","name":"vendor","type":"string","default":"","description":"Filter results by product vendor"}]}]

operations:
  [{"type":"resource","resource":"order","name":"Order"},{"type":"resource","resource":"product","name":"Product"},{"type":"operation","operation":"create","name":"Create","action":"Create an order","resources":["order"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an order","resources":["order"]},{"type":"operation","operation":"get","name":"Get","action":"Get an order","resources":["order"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many orders","resources":["order"]},{"type":"operation","operation":"update","name":"Update","action":"Update an order","resources":["order"]},{"type":"operation","operation":"create","name":"Create","action":"Create a product","resources":["product"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a product","resources":["product"]},{"type":"operation","operation":"get","name":"Get","action":"Get a product","resources":["product"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many products","resources":["product"]},{"type":"operation","operation":"update","name":"Update","action":"Update a product","resources":["product"]}]

credentials_required:
  [{"name":"shopifyApi","required":true,"displayOptions":{"show":{"authentication":["apiKey"]}}},{"name":"shopifyAccessTokenApi","required":true,"displayOptions":{"show":{"authentication":["accessToken"]}}},{"name":"shopifyOAuth2Api","required":true,"displayOptions":{"show":{"authentication":["oAuth2"]}}}]


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

  # Shopify Trigger node

  [Shopify](https://www.shopify.com/){:target=_blank .external-link} is an e-commerce platform that allows users to set up an online store and sell their products.

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"Access Token","value":"accessToken"},{"name":"OAuth2","value":"oAuth2"},{"name":"API Key","value":"apiKey"}],"default":"apiKey"},{"displayName":"Trigger On","name":"topic","type":"options","default":"","options":[{"name":"App Uninstalled","value":"app/uninstalled"},{"name":"Cart Created","value":"carts/create"},{"name":"Cart Updated","value":"carts/update"},{"name":"Checkout Created","value":"checkouts/create"},{"name":"Checkout Delete","value":"checkouts/delete"},{"name":"Checkout Update","value":"checkouts/update"},{"name":"Collection Created","value":"collections/create"},{"name":"Collection Deleted","value":"collections/delete"},{"name":"Collection Listings Added","value":"collection_listings/add"},{"name":"Collection Listings Removed","value":"collection_listings/remove"},{"name":"Collection Listings Updated","value":"collection_listings/update"},{"name":"Collection Updated","value":"collections/update"},{"name":"Customer Created","value":"customers/create"},{"name":"Customer Deleted","value":"customers/delete"},{"name":"Customer Disabled","value":"customers/disable"},{"name":"Customer Enabled","value":"customers/enable"},{"name":"Customer Groups Created","value":"customer_groups/create"},{"name":"Customer Groups Deleted","value":"customer_groups/delete"},{"name":"Customer Groups Updated","value":"customer_groups/update"},{"name":"Customer Updated","value":"customers/update"},{"name":"Draft Orders Created","value":"draft_orders/create"},{"name":"Draft Orders Deleted","value":"draft_orders/delete"},{"name":"Draft Orders Updated","value":"draft_orders/update"},{"name":"Fulfillment Created","value":"fulfillments/create"},{"name":"Fulfillment Events Created","value":"fulfillment_events/create"},{"name":"Fulfillment Events Deleted","value":"fulfillment_events/delete"},{"name":"Fulfillment Updated","value":"fulfillments/update"},{"name":"Inventory Items Created","value":"inventory_items/create"},{"name":"Inventory Items Deleted","value":"inventory_items/delete"},{"name":"Inventory Items Updated","value":"inventory_items/update"},{"name":"Inventory Levels Connected","value":"inventory_levels/connect"},{"name":"Inventory Levels Disconnected","value":"inventory_levels/disconnect"},{"name":"Inventory Levels Updated","value":"inventory_levels/update"},{"name":"Locale Created","value":"locales/create"},{"name":"Locale Updated","value":"locales/update"},{"name":"Location Created","value":"locations/create"},{"name":"Location Deleted","value":"locations/delete"},{"name":"Location Updated","value":"locations/update"},{"name":"Order Cancelled","value":"orders/cancelled"},{"name":"Order Created","value":"orders/create"},{"name":"Order Fulfilled","value":"orders/fulfilled"},{"name":"Order Paid","value":"orders/paid"},{"name":"Order Partially Fulfilled","value":"orders/partially_fulfilled"},{"name":"Order Transactions Created","value":"order_transactions/create"},{"name":"Order Updated","value":"orders/updated"},{"name":"Orders Deleted","value":"orders/delete"},{"name":"Product Created","value":"products/create"},{"name":"Product Deleted","value":"products/delete"},{"name":"Product Listings Added","value":"product_listings/add"},{"name":"Product Listings Removed","value":"product_listings/remove"},{"name":"Product Listings Updated","value":"product_listings/update"},{"name":"Product Updated","value":"products/update"},{"name":"Refund Created","value":"refunds/create"},{"name":"Shop Updated","value":"shop/update"},{"name":"Tender Transactions Created","value":"tender_transactions/create"},{"name":"Theme Created","value":"themes/create"},{"name":"Theme Deleted","value":"themes/delete"},{"name":"Theme Published","value":"themes/publish"},{"name":"Theme Updated","value":"themes/update"}]}]

credentials_required:
  [{"name":"shopifyApi","required":true,"displayOptions":{"show":{"authentication":["apiKey"]}}},{"name":"shopifyAccessTokenApi","required":true,"displayOptions":{"show":{"authentication":["accessToken"]}}},{"name":"shopifyOAuth2Api","required":true,"displayOptions":{"show":{"authentication":["oAuth2"]}}}]


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

  # SIGNL4 node

  Use the SIGNL4 node to automate work in SIGNL4, and integrate SIGNL4 with other applications. n8n supports sending and resolving alerts with SIGNL4.

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

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

  ## Operations

  * Alert
      * Send an alert
      * Resolve an alert

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Alert","value":"alert"}],"default":"alert"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["alert"]}},"options":[{"name":"Send","value":"send","description":"Send an alert","action":"Send an alert"},{"name":"Resolve","value":"resolve","description":"Resolve an alert","action":"Resolve an alert"}],"default":"send"},{"displayName":"Message","name":"message","type":"string","default":"","displayOptions":{"show":{"operation":["send"],"resource":["alert"]}},"description":"A more detailed description for the alert"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["send"],"resource":["alert"]}},"default":{},"options":[{"displayName":"Alerting Scenario","name":"alertingScenario","type":"options","options":[{"name":"Single ACK","value":"single_ack","description":"In case only one person needs to confirm this Signl"},{"name":"Multi ACK","value":"multi_ack","description":"In case this alert must be confirmed by the number of people who are on duty at the time this Singl is raised"}],"default":"single_ack"},{"displayName":"Attachments","name":"attachmentsUi","placeholder":"Add Attachments","type":"fixedCollection","typeOptions":{"multipleValues":false},"options":[{"name":"attachmentsBinary","displayName":"Attachments Binary","values":[{"displayName":"Property Name","name":"property","type":"string","placeholder":"data","default":"","description":"Name of the binary properties which contain data which should be added as attachment"}]}],"default":{}},{"displayName":"External ID","name":"externalId","type":"string","default":"","description":"If the event originates from a record in a 3rd party system, use this parameter to pass the unique ID of that record. That ID will be communicated in outbound webhook notifications from SIGNL4, which is great for correlation/synchronization of that record with the alert. If you resolve / close an alert you must use the same External ID as in the original alert."},{"displayName":"Filtering","name":"filtering","type":"boolean","default":false,"description":"Whether to apply event filtering for this event, or not. If set to true, the event will only trigger a notification to the team, if it contains at least one keyword from one of your services and system categories (i.e. it is whitelisted)"},{"displayName":"Location","name":"locationFieldsUi","type":"fixedCollection","placeholder":"Add Location","default":{},"description":"Transmit location information ('latitude, longitude') with your event and display a map in the mobile app","options":[{"name":"locationFieldsValues","displayName":"Location","values":[{"displayName":"Latitude","name":"latitude","type":"string","required":true,"description":"The location latitude","default":""},{"displayName":"Longitude","name":"longitude","type":"string","required":true,"description":"The location longitude","default":""}]}]},{"displayName":"Service","name":"service","type":"string","default":"","description":"Assigns the alert to the service/system category with the specified name"},{"displayName":"Title","name":"title","type":"string","default":"","description":"The title or subject of this alert"}]},{"displayName":"External ID","name":"externalId","type":"string","default":"","displayOptions":{"show":{"operation":["resolve"],"resource":["alert"]}},"description":"If the event originates from a record in a 3rd party system, use this parameter to pass the unique ID of that record. That ID will be communicated in outbound webhook notifications from SIGNL4, which is great for correlation/synchronization of that record with the alert. If you resolve / close an alert you must use the same External ID as in the original alert."}]

operations:
  [{"type":"resource","resource":"alert","name":"Alert"},{"type":"operation","operation":"send","name":"Send","action":"Send an alert","resources":["alert"]},{"type":"operation","operation":"resolve","name":"Resolve","action":"Resolve an alert","resources":["alert"]}]


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

  # Slack node

  Use the Slack node to automate work in Slack, and integrate Slack with other applications. n8n has built-in support for a wide range of Slack features, including creating, archiving, and closing channels, getting users and files, as well as deleting messages.

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

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

  ## Operations

  * **Channel**
      * **Archive** a channel.
      * **Close** a direct message or multi-person direct message.
      * **Create** a public or private channel-based conversation.
      * **Get** information about a channel.
      * **Get Many**: Get a list of channels in Slack.
      * **History**: Get a channel's history of messages and events.
      * **Invite** a user to a channel.
      * **Join** an existing channel.
      * **Kick**: Remove a user from a channel.
      * **Leave** a channel.
      * **Member**: List the members of a channel.
      * **Open** or resume a direct message or multi-person direct message.
      * **Rename** a channel.
      * **Replies**: Get a thread of messages posted to a channel.
      * **Sets purpose** of a channel.
      * **Sets topic** of a channel.
      * **Unarchive** a channel.
  * **File**
      * **Get** a file.
      * **Get Many**: Get and filter team files.
      * **Upload**: Create or upload an existing file.
  * **Message**
      * **Delete** a message
      * **Get permalink**: Get a message's permalink.
      * **Search** for messages
      * **Send** a message
      * **Send and Wait for Approval**: Send a message and wait for approval from the recipient before continuing.
      * **Update** a message
  * **Reaction**
      * **Add** a reaction to a message.
      * **Get** a message's reactions.
      * **Remove** a reaction from a message.
  * **Star**
      * **Add** a star to an item.
      * **Delete** a star from an item.
      * **Get Many**: Get a list of an authenticated user's stars.
  * **User**
      * **Get** information about a user.
  	* **Get Many**: Get a list of users.
      * **Get User's Profile**.
      * **Get User's Status**.
  	* **Update User's Profile**.
  * **User Group**
      * **Create** a user group.
      * **Disable** a user group.
      * **Enable** a user group.
      * **Get Many**: Get a list of user groups.
      * **Update** a user group.

  ## Templates and examples

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

  ## Related resources

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

  ## Required scopes

  Once you create a Slack app for your [Slack credentials](/integrations/builtin/credentials/slack.md), you must add the appropriate scopes to your Slack app for this node to work. Start with the scopes listed in the [Scopes | Slack credentials](/integrations/builtin/credentials/slack.md#scopes) page.

  If those aren't enough, use the table below to look up the resource and operation you want to use, then follow the link to Slack's API documentation to find the correct scopes.

  <!-- vale off -->

  | **Resource** | **Operation** | **Slack API method** |
  | --- | --- | --- |
  | Channel | Archive | [conversations.archive](https://api.slack.com/methods/conversations.archive){:target=blank .external-link} |
  | Channel | Close | [conversations.close](https://api.slack.com/methods/conversations.close){:target=blank .external-link} |
  | Channel | Create | [conversations.create](https://api.slack.com/methods/conversations.create){:target=blank .external-link} |
  | Channel | Get | [conversations.info](https://api.slack.com/methods/conversations.info){:target=blank .external-link} |
  | Channel | Get Many | [conversations.list](https://api.slack.com/methods/conversations.list){:target=blank .external-link} |
  | Channel | History | [conversations.history](https://api.slack.com/methods/conversations.history){:target=blank .external-link} |
  | Channel | Invite | [conversations.invite](https://api.slack.com/methods/conversations.invite){:target=blank .external-link} |
  | Channel | Join | [conversations.join](https://api.slack.com/methods/conversations.join){:target=blank .external-link} |
  | Channel | Kick | [conversations.kick](https://api.slack.com/methods/conversations.kick){:target=blank .external-link} |
  | Channel | Leave | [conversations.leave](https://api.slack.com/methods/conversations.leave){:target=blank .external-link} |
  | Channel | Member | [conversations.members](https://api.slack.com/methods/conversations.members){:target=blank .external-link} |
  | Channel | Open | [conversations.open](https://api.slack.com/methods/conversations.open){:target=blank .external-link} |
  | Channel | Rename | [conversations.rename](https://api.slack.com/methods/conversations.rename){:target=blank .external-link} |
  | Channel | Replies | [conversations.replies](https://api.slack.com/methods/conversations.replies){:target=blank .external-link} |
  | Channel | Set Purpose | [conversations.setPurpose](https://api.slack.com/methods/conversations.setPurpose){:target=blank .external-link} |
  | Channel | Set Topic | [conversations.setTopic](https://api.slack.com/methods/conversations.setTopic){:target=blank .external-link} |
  | Channel | Unarchive | [conversations.unarchive](https://api.slack.com/methods/conversations.unarchive){:target=blank .external-link} |
  | File | Get | [files.info](https://api.slack.com/methods/files.info){:target=blank .external-link} |
  | File | Get Many | [files.list](https://api.slack.com/methods/files.list){:target=blank .external-link} |
  | File | Upload | [files.upload](https://api.slack.com/methods/files.upload){:target=blank .external-link} |
  | Message | Delete | [chat.delete](https://api.slack.com/methods/chat.delete){:target=blank .external-link} |
  | Message | Get Permalink | [chat.getPermalink](https://api.slack.com/methods/chat.getPermalink){:target=blank .external-link} |
  | Message | Search | [search.messages](https://api.slack.com/methods/search.messages){:target=blank .external-link} |
  | Message | Send | [chat.postMessage](https://api.slack.com/methods/chat.postMessage){:target=blank .external-link} |
  | Message | Send and Wait for Approval | [chat.postMessage](https://api.slack.com/methods/chat.postMessage){:target=blank .external-link} |
  | Message | Update | [chat.update](https://api.slack.com/methods/chat.update){:target=blank .external-link} |
  | Reaction | Add | [reactions.add](https://api.slack.com/methods/reactions.add){:target=blank .external-link} |
  | Reaction | Get | [reactions.get](https://api.slack.com/methods/reactions.get){:target=blank .external-link} |
  | Reaction | Remove | [reactions.remove](https://api.slack.com/methods/reactions.remove){:target=blank .external-link} |
  | Star | Add | [stars.add](https://api.slack.com/methods/stars.add){:target=blank .external-link} |
  | Star | Delete | [stars.remove](https://api.slack.com/methods/stars.remove){:target=blank .external-link} |
  | Star | Get Many | [stars.list](https://api.slack.com/methods/stars.list){:target=blank .external-link} |
  | User | Get | [users.info](https://api.slack.com/methods/users.info){:target=blank .external-link} |
  | User | Get Many | [users.list](https://api.slack.com/methods/users.list){:target=blank .external-link} |
  | User | Get User's Profile | [users.profile.get](https://api.slack.com/methods/users.profile.get){:target=blank .external-link} |
  | User | Get User's Status | [users.getPresence](https://api.slack.com/methods/users.getPresence){:target=blank .external-link} |
  | User | Update User's Profile | [users.profile.set](https://api.slack.com/methods/users.profile.set){:target=blank .external-link} |
  | User Group | Create | [usergroups.create](https://api.slack.com/methods/usergroups.create){:target=blank .external-link} |
  | User Group | Disable | [usergroups.disable](https://api.slack.com/methods/usergroups.disable){:target=blank .external-link} |
  | User Group | Enable | [usergroups.enable](https://api.slack.com/methods/usergroups.enable){:target=blank .external-link} |
  | User Group | Get Many | [usergroups.list](https://api.slack.com/methods/usergroups.list){:target=blank .external-link} |
  | User Group | Update | [usergroups.update](https://api.slack.com/methods/usergroups.update){:target=blank .external-link} |

  <!-- vale on -->

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


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

  # seven node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"sms","name":"SMS"},{"type":"resource","resource":"voice","name":"Voice Call"},{"type":"operation","operation":"send","name":"Send","action":"Send an SMS","resources":["sms"]},{"type":"operation","operation":"send","name":"Send","action":"Convert text to voice","resources":["voice"]}]


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

  # Snowflake node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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


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

  # Loop Over Items

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

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

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

  ## When to use the Loop Over Items node

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

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

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

  ## Node parameters

  ### Batch Size

  Enter the number of items to return with each call.

  ## Node options

  ### Reset

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

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

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

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

  ## Templates and examples

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

  ### Read RSS feed from two different sources

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

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

  The final workflow looks like this:

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

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

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

  ### Check that the node has processed all items

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

  ### Get the current running index of the node

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


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

  # Splunk node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"firedAlert","name":"Fired Alert"},{"type":"resource","resource":"searchConfiguration","name":"Search Configuration"},{"type":"resource","resource":"searchJob","name":"Search Job"},{"type":"resource","resource":"searchResult","name":"Search Result"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"getReport","name":"Get Report","action":"Get a fired alerts report","resources":["firedAlert"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a search configuration","resources":["searchConfiguration"]},{"type":"operation","operation":"get","name":"Get","action":"Get a search configuration","resources":["searchConfiguration"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many search configurations","resources":["searchConfiguration"]},{"type":"operation","operation":"create","name":"Create","action":"Create a search job","resources":["searchJob"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a search job","resources":["searchJob"]},{"type":"operation","operation":"get","name":"Get","action":"Get a search job","resources":["searchJob"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many search jobs","resources":["searchJob"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many search results","resources":["searchResult"]},{"type":"operation","operation":"create","name":"Create","action":"Create a user","resources":["user"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a user","resources":["user"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]},{"type":"operation","operation":"update","name":"Update","action":"Update a user","resources":["user"]}]


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

  # Spontit node

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

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

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

  ## Operations

  * Push
      * Create a push notification

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"push","name":"Push"},{"type":"operation","operation":"create","name":"Create","action":"Create a push notification","resources":["push"]}]


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

  # Spotify node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"album","name":"Album"},{"type":"resource","resource":"artist","name":"Artist"},{"type":"resource","resource":"library","name":"Library"},{"type":"resource","resource":"myData","name":"My Data"},{"type":"resource","resource":"player","name":"Player"},{"type":"resource","resource":"playlist","name":"Playlist"},{"type":"resource","resource":"track","name":"Track"},{"type":"operation","operation":"addSongToQueue","name":"Add Song to Queue","action":"Add a song to a queue","resources":["player"]},{"type":"operation","operation":"currentlyPlaying","name":"Currently Playing","action":"Get the currently playing track","resources":["player"]},{"type":"operation","operation":"nextSong","name":"Next Song","action":"Skip to the next track","resources":["player"]},{"type":"operation","operation":"pause","name":"Pause","action":"Pause the player","resources":["player"]},{"type":"operation","operation":"previousSong","name":"Previous Song","action":"Skip to the previous song","resources":["player"]},{"type":"operation","operation":"recentlyPlayed","name":"Recently Played","action":"Get the recently played tracks","resources":["player"]},{"type":"operation","operation":"resume","name":"Resume","action":"Resume the player","resources":["player"]},{"type":"operation","operation":"volume","name":"Set Volume","action":"Set volume on the player","resources":["player"]},{"type":"operation","operation":"startMusic","name":"Start Music","action":"Start music on the player","resources":["player"]},{"type":"operation","operation":"get","name":"Get","action":"Get an album","resources":["album"]},{"type":"operation","operation":"getNewReleases","name":"Get New Releases","action":"Get new album releases","resources":["album"]},{"type":"operation","operation":"getTracks","name":"Get Tracks","action":"Get an album's tracks by URI or ID","resources":["album"]},{"type":"operation","operation":"search","name":"Search","action":"Search albums by keyword","resources":["album"]},{"type":"operation","operation":"get","name":"Get","action":"Get an artist","resources":["artist"]},{"type":"operation","operation":"getAlbums","name":"Get Albums","action":"Get an artist's albums by URI or ID","resources":["artist"]},{"type":"operation","operation":"getRelatedArtists","name":"Get Related Artists","action":"Get an artist's related artists by URI or ID","resources":["artist"]},{"type":"operation","operation":"getTopTracks","name":"Get Top Tracks","action":"Get an artist's top tracks by URI or ID","resources":["artist"]},{"type":"operation","operation":"search","name":"Search","action":"Search artists by keyword","resources":["artist"]},{"type":"operation","operation":"add","name":"Add an Item","action":"Add an Item to a playlist","resources":["playlist"]},{"type":"operation","operation":"create","name":"Create a Playlist","action":"Create a playlist","resources":["playlist"]},{"type":"operation","operation":"get","name":"Get","action":"Get a playlist","resources":["playlist"]},{"type":"operation","operation":"getUserPlaylists","name":"Get the User's Playlists","action":"Get a user's playlists","resources":["playlist"]},{"type":"operation","operation":"getTracks","name":"Get Tracks","action":"Get a playlist's tracks by URI or ID","resources":["playlist"]},{"type":"operation","operation":"delete","name":"Remove an Item","action":"Remove an item from a playlist","resources":["playlist"]},{"type":"operation","operation":"search","name":"Search","action":"Search playlists by keyword","resources":["playlist"]},{"type":"operation","operation":"get","name":"Get","action":"Get a track","resources":["track"]},{"type":"operation","operation":"getAudioFeatures","name":"Get Audio Features","action":"Get audio features of a track","resources":["track"]},{"type":"operation","operation":"search","name":"Search","action":"Search tracks by keyword","resources":["track"]},{"type":"operation","operation":"getLikedTracks","name":"Get Liked Tracks","action":"Get liked tracks","resources":["library"]},{"type":"operation","operation":"getFollowingArtists","name":"Get Following Artists","action":"Get your followed artists","resources":["myData"]}]


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

  # SSE Trigger node

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

  ## Node parameters

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


  ## Templates and examples

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

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


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

  # SSH

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

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

  ## Operations

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

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

  ### Execute Command

  Configure this operation with these parameters:

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

  ### Download File

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

  #### Download File options

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

  ### Upload File

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

  #### Upload File options

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

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"command","name":"Command"},{"type":"resource","resource":"file","name":"File"},{"type":"operation","operation":"execute","name":"Execute","action":"Execute a command","resources":["command"]},{"type":"operation","operation":"download","name":"Download","action":"Download a file","resources":["file"]},{"type":"operation","operation":"upload","name":"Upload","action":"Upload a file","resources":["file"]}]

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


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

  # Stackby node

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

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

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

  ## Operations

  - Append
  - Delete
  - List
  - Read

  ## Templates and examples

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

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


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

  # Stop And Error

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

  ## Operations

  * Error Message
  * Error Object

  ## Node parameters

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

  The other parameters depend on which operation you select.

  ### Error Message parameters

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

  ### Error Object parameters

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

  ## Templates and examples

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

  ## Related resources

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

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

properties_schema:
  [{"displayName":"Error Type","name":"errorType","type":"options","options":[{"name":"Error Message","value":"errorMessage"},{"name":"Error Object","value":"errorObject"}],"default":"errorMessage","description":"Type of error to throw"},{"displayName":"Error Message","name":"errorMessage","type":"string","placeholder":"An error occurred!","default":"","required":true,"displayOptions":{"show":{"errorType":["errorMessage"]}}},{"displayName":"Error Object","name":"errorObject","type":"json","description":"Object containing error properties","default":"","typeOptions":{"alwaysOpenEditWindow":true},"placeholder":"{\n\t\"code\": \"404\",\n\t\"description\": \"The resource could not be fetched\"\n}","required":true,"displayOptions":{"show":{"errorType":["errorObject"]}}}]


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

  # Storyblok node

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

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

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

  ## Operations

  ### Content API

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


  ### Management API

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

  ## Templates and examples

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

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

operations:
  [{"type":"resource","resource":"story","name":"Story"},{"type":"operation","operation":"get","name":"Get","action":"Get a story","resources":["story"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many stories","resources":["story"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a story","resources":["story"]},{"type":"operation","operation":"get","name":"Get","action":"Get a story","resources":["story"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many stories","resources":["story"]},{"type":"operation","operation":"publish","name":"Publish","action":"Publish a story","resources":["story"]},{"type":"operation","operation":"unpublish","name":"Unpublish","action":"Unpublish a story","resources":["story"]}]

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


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

  # Strapi node

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

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

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

  ## Operations

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

  ## Templates and examples

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

  ## Related resources

  Refer to [Strapi's documentation](https://docs.strapi.io/dev-docs/api/rest){:target=_blank .external-link} for more information about the service.

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

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

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

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


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

  # Strava node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Activity","value":"activity"}],"default":"activity"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["activity"]}},"options":[{"name":"Create","value":"create","description":"Create a new activity","action":"Create an activity"},{"name":"Get","value":"get","description":"Get an activity","action":"Get an activity"},{"name":"Get Comments","value":"getComments","description":"Get all activity comments","action":"Get all activity comments"},{"name":"Get Kudos","value":"getKudos","description":"Get all activity kudos","action":"Get all activity kudos"},{"name":"Get Laps","value":"getLaps","description":"Get all activity laps","action":"Get all activity laps"},{"name":"Get Many","value":"getAll","description":"Get many activities","action":"Get many activities"},{"name":"Get Streams","value":"getStreams","description":"Get activity streams","action":"Get all activity streams"},{"name":"Get Zones","value":"getZones","description":"Get all activity zones","action":"Get all activity zones"},{"name":"Update","value":"update","description":"Update an activity","action":"Update an activity"}],"default":"create"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"default":"","description":"The name of the activity"},{"displayName":"Type","name":"type","type":"string","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"default":"","description":"Type of activity. For example - Run, Ride etc."},{"displayName":"Start Date","name":"startDate","type":"dateTime","default":"","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"description":"ISO 8601 formatted date time"},{"displayName":"Elapsed Time (Seconds)","name":"elapsedTime","type":"number","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"typeOptions":{"minValue":0},"default":0,"description":"In seconds"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["create"]}},"options":[{"displayName":"Commute","name":"commute","type":"boolean","default":false,"description":"Whether to mark as commute"},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the activity"},{"displayName":"Distance","name":"distance","type":"number","typeOptions":{"minValue":0},"default":0,"description":"In meters"},{"displayName":"Trainer","name":"trainer","type":"boolean","default":false,"description":"Whether to mark as a trainer activity"}]},{"displayName":"Activity ID","name":"activityId","type":"string","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["update"]}},"default":"","description":"ID or email of activity"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["activity"],"operation":["update"]}},"options":[{"displayName":"Commute","name":"commute","type":"boolean","default":false,"description":"Whether to mark as commute"},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the activity"},{"displayName":"Gear ID","name":"gear_id","type":"string","default":"","description":"Identifier for the gear associated with the activity. ‘none’ clears gear from activity."},{"displayName":"Mute Activity","name":"hide_from_home","type":"boolean","default":false,"description":"Do not publish to Home or Club feeds"},{"displayName":"Name","name":"name","type":"string","default":"","description":"The name of the activity"},{"displayName":"Type","name":"type","type":"string","default":"","description":"Type of activity. For example - Run, Ride etc."},{"displayName":"Trainer","name":"trainer","type":"boolean","default":false,"description":"Whether to mark as a trainer activity"}]},{"displayName":"Activity ID","name":"activityId","type":"string","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["get"]}},"default":"","description":"ID or email of activity"},{"displayName":"Activity ID","name":"activityId","type":"string","required":true,"displayOptions":{"show":{"resource":["activity"],"operation":["getComments","getLaps","getKudos","getZones","getStreams"]}},"default":"","description":"ID or email of activity"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["activity"],"operation":["getComments","getLaps","getKudos","getZones"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["activity"],"operation":["getComments","getLaps","getKudos","getZones"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Keys","name":"keys","type":"multiOptions","options":[{"name":"Altitude","value":"altitude"},{"name":"Cadence","value":"cadence"},{"name":"Distance","value":"distance"},{"name":"Gradient","value":"grade_smooth"},{"name":"Heartrate","value":"heartrate"},{"name":"Latitude / Longitude","value":"latlng"},{"name":"Moving","value":"moving"},{"name":"Temperature","value":"temp"},{"name":"Time","value":"time"},{"name":"Velocity","value":"velocity_smooth"},{"name":"Watts","value":"watts"}],"displayOptions":{"show":{"resource":["activity"],"operation":["getStreams"]}},"required":true,"default":[],"description":"Desired stream types to return"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["activity"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["activity"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"}]

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


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

  # Strava Trigger node

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

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

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

  ## Events

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

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


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

  # Stripe node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"balance","name":"Balance"},{"type":"resource","resource":"charge","name":"Charge"},{"type":"resource","resource":"coupon","name":"Coupon"},{"type":"resource","resource":"customer","name":"Customer"},{"type":"resource","resource":"customerCard","name":"Customer Card"},{"type":"resource","resource":"source","name":"Source"},{"type":"resource","resource":"token","name":"Token"},{"type":"operation","operation":"get","name":"Get","action":"Get a balance","resources":["balance"]},{"type":"operation","operation":"add","name":"Add","action":"Add a customer card","resources":["customerCard"]},{"type":"operation","operation":"get","name":"Get","action":"Get a customer card","resources":["customerCard"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a customer card","resources":["customerCard"]},{"type":"operation","operation":"create","name":"Create","action":"Create a charge","resources":["charge"]},{"type":"operation","operation":"get","name":"Get","action":"Get a charge","resources":["charge"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many charges","resources":["charge"]},{"type":"operation","operation":"update","name":"Update","action":"Update a charge","resources":["charge"]},{"type":"operation","operation":"create","name":"Create","action":"Create a coupon","resources":["coupon"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many coupons","resources":["coupon"]},{"type":"operation","operation":"create","name":"Create","action":"Create a customer","resources":["customer"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a customer","resources":["customer"]},{"type":"operation","operation":"get","name":"Get","action":"Get a customer","resources":["customer"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many customers","resources":["customer"]},{"type":"operation","operation":"update","name":"Update","action":"Update a customer","resources":["customer"]},{"type":"operation","operation":"create","name":"Create","action":"Create a source","resources":["source"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a source","resources":["source"]},{"type":"operation","operation":"get","name":"Get","action":"Get a source","resources":["source"]},{"type":"operation","operation":"create","name":"Create","action":"Create a token","resources":["token"]}]


