Zendesk

Node: zendesk · Full type: n8n-nodes-base.zendesk · Version: 1

Credentials

zendeskApi (alias: @zendesk) / zendeskOAuth2Api (alias: @zendesk)

CREDENTIAL @zendesk = zendeskApi "My Zendesk"

Operations

Resource: ticket

create

Parameter	Type	Default	Details
description	string	""	required
jsonParameters	boolean	false
additionalFields	collection	{}	keys: customFieldsUi, externalId, group, recipient, status, subject, ...
additionalFieldsJson	json	""

delete

Parameter	Type	Default	Details
ticketType	options	"regular"	required; regular, suspended
id	string	""	required
id	string	""	required

get

Parameter	Type	Default	Details
ticketType	options	"regular"	required; regular, suspended
id	string	""	required
id	string	""	required

getAll

Parameter	Type	Default	Details
ticketType	options	"regular"	required; regular, suspended
returnAll	boolean	false
limit	number	100
options	collection	{}	keys: group, query, sortBy, sortOrder, status

recover

Parameter	Type	Default	Details
id	string	""	required

update

Parameter	Type	Default	Details
id	string	""	required
jsonParameters	boolean	false
updateFields	collection	{}	keys: assigneeEmail, customFieldsUi, externalId, group, internalNote, publicReply, ...
updateFieldsJson	json	""

Resource: ticketField

get

Parameter	Type	Default	Details
ticketFieldId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100

Resource: user

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: alias, custom_role_id, details, email, external_id, locale, ...

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: role

getOrganizations

Parameter	Type	Default	Details
id	string	""	required

getRelatedData

Parameter	Type	Default	Details
id	string	""	required

search

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: query, external_id

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: alias, custom_role_id, details, email, external_id, locale, ...

Resource: organization

count

No additional parameters.

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: details, domain_names, notes, organizationFieldsUi, tags

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100

getRelatedData

Parameter	Type	Default	Details
id	string	""	required

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: details, domain_names, name, notes, organizationFieldsUi, tags

Common Parameters

Parameter	Type	Default	Details
authentication	options	"apiToken"	apiToken, oAuth2

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
customFieldsUi	fixedCollection	{}	groups: customFieldsValues
externalId	string	""
group	options	""
recipient	string	""
status	options	""	closed, new, hold, open, pending, solved
subject	string	""
tags	multiOptions	[]
type	options	""	question, incident, problem, task

updateFields children:

Parameter	Type	Default	Details
assigneeEmail	string	""
customFieldsUi	fixedCollection	{}	groups: customFieldsValues
externalId	string	""
group	options	""
internalNote	string	""
publicReply	string	""
recipient	string	""
status	options	""	closed, new, hold, open, pending, solved
subject	string	""
tags	multiOptions	[]
type	options	""	question, incident, problem, task

options children:

Parameter	Type	Default	Details
group	options	""
query	string	""
sortBy	options	"updated_at"	created_at, priority, status, ticket_type, updated_at
sortOrder	options	"asc"	asc, desc
status	options	""	closed, new, hold, open, pending, solved

filters children:

Parameter	Type	Default	Details
role	multiOptions	[]	multi: end-user, agent, admin

Example

NODE "zendesk" @zendesk AS "Zendesk" {
  resource: "ticket",
  operation: "get",
  description: {{ $json.description }},
  id: {{ $json.id }},
  ticketFieldId: {{ $json.ticketFieldId }}
}