zendesk.json•10.4 kB
{
"nodeType": "n8n-nodes-base.zendesk",
"displayName": "Zendesk",
"description": "Consume Zendesk API",
"version": 1,
"properties": [
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"organization"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Details about the organization, such as the address",
"placeholder": "Add Field",
"options": [
{
"name": "details",
"displayName": "Details",
"type": "string",
"default": "",
"description": "Details about the organization, such as the address"
},
{
"name": "domain_names",
"displayName": "Domain Names",
"type": "string",
"default": "",
"description": "Comma-separated domain names associated with this organization"
},
{
"name": "notes",
"displayName": "Notes",
"type": "string",
"default": ""
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"organization"
],
"operation": [
"create"
]
}
}
},
{
"name": "id",
"displayName": "Organization ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"organization"
],
"operation": [
"update"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Details about the organization, such as the address",
"placeholder": "Add Field",
"options": [
{
"name": "details",
"displayName": "Details",
"type": "string",
"default": "",
"description": "Details about the organization, such as the address"
},
{
"name": "domain_names",
"displayName": "Domain Names",
"type": "string",
"default": "",
"description": "Comma-separated domain names associated with this organization"
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": ""
},
{
"name": "notes",
"displayName": "Notes",
"type": "string",
"default": ""
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"organization"
],
"operation": [
"update"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"organization"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 100,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 100
},
"displayOptions": {
"show": {
"resource": [
"organization"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "create",
"description": "Count organizations",
"options": [
{
"name": "Count",
"value": "count",
"description": "Count organizations"
},
{
"name": "Create",
"value": "create",
"description": "Create an organization"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete an organization"
},
{
"name": "Get",
"value": "get",
"description": "Get an organization"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many organizations"
},
{
"name": "Get Related Data",
"value": "getRelatedData",
"description": "Get data related to the organization"
},
{
"name": "Update",
"value": "update",
"description": "Update a organization"
}
],
"displayOptions": {
"show": {
"resource": [
"organization"
]
}
}
},
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "The first comment on the ticket",
"required": true,
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "jsonParameters",
"displayName": "JSON Parameters",
"type": "boolean",
"default": false,
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFieldsJson",
"displayName": "Additional Fields",
"type": "json",
"default": "",
"description": "Object of values to set as described <a href=\"https://developer.zendesk.com/rest_api/docs/support/tickets\">here</a>",
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
],
"jsonParameters": [
true
]
}
}
},
{
"name": "updateFieldsJson",
"displayName": "Update Fields",
"type": "json",
"default": "",
"description": "Object of values to update as described <a href=\"https://developer.zendesk.com/rest_api/docs/support/tickets\">here</a>",
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"update"
],
"jsonParameters": [
true
]
}
}
},
{
"name": "ticketType",
"displayName": "Ticket Type",
"type": "options",
"default": "regular",
"required": true,
"options": [
{
"name": "Regular",
"value": "regular"
},
{
"name": "Suspended",
"value": "suspended"
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"get",
"delete",
"getAll"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "The group to search. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add option",
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "ticketFieldId",
"displayName": "Ticket Field ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"ticketField"
],
"operation": [
"get"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"placeholder": "Add Filter",
"displayOptions": {
"show": {
"resource": [
"user"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "authentication",
"displayName": "Authentication",
"type": "options",
"default": "apiToken",
"options": [
{
"name": "API Token",
"value": "apiToken"
},
{
"name": "OAuth2",
"value": "oAuth2"
}
]
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "ticket",
"description": "Tickets are the means through which your end users (customers) communicate with agents in Zendesk Support",
"options": [
{
"name": "Ticket",
"value": "ticket",
"description": "Tickets are the means through which your end users (customers) communicate with agents in Zendesk Support"
},
{
"name": "Ticket Field",
"value": "ticketField",
"description": "Manage system and custom ticket fields"
},
{
"name": "User",
"value": "user",
"description": "Manage users"
},
{
"name": "Organization",
"value": "organization",
"description": "Manage organizations"
}
]
}
],
"credentialsConfig": [
{
"name": "zendeskApi",
"required": true
},
{
"name": "authentication",
"required": false
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}