Zammad

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

Credentials

zammadBasicAuthApi (alias: @zammad) / zammadTokenAuthApi (alias: @zammad)

CREDENTIAL @zammad = zammadBasicAuthApi "My Zammad"

Operations

Resource: group

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: active, customFieldsUi, note

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	50

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: active, customFieldsUi, name, note

Resource: organization

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: shared, domain, domain_assignment, active, vip, note, ...

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	50

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: shared, domain, domain_assignment, active, vip, note, ...

Resource: ticket

create

Parameter	Type	Default	Details
title	string	""	required
group	options	""	required
customer	options	""	required
article	fixedCollection	{}	required; groups: articleDetails
additionalFields	collection	{}	keys: customFieldsUi

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	50

Resource: user

create

Parameter	Type	Default	Details
firstname	string	""	required
lastname	string	""	required
additionalFields	collection	{}	keys: active, addressUi, customFieldsUi, department, email, fax, ...

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	50
filters	collection	{}	keys: query, sortUi

getSelf

No additional parameters.

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: active, addressUi, customFieldsUi, department, email, fax, ...

Common Parameters

Parameter	Type	Default	Details
authentication	options	"tokenAuth"	basicAuth, tokenAuth

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
active	boolean	true
customFieldsUi	fixedCollection	{}	groups: customFieldPairs
note	string	""

updateFields children:

Parameter	Type	Default	Details
active	boolean	true
customFieldsUi	fixedCollection	{}	groups: customFieldPairs
name	string	""
note	string	""

article children:

articleDetails group:

Parameter	Type	Default	Details
subject	string	""
body	string	""
visibility	options	"internal"	external, internal
sender	options	"Agent"	Agent, Customer, System
type	options	"note"	chat, email, fax, note, phone, sms
reply_to	string	""

filters children:

Parameter	Type	Default	Details
query	string	""
sortUi	fixedCollection	{}	groups: sortDetails

Example

NODE "zammad" @zammad AS "Zammad" {
  resource: "group",
  operation: "get",
  name: {{ $json.name }},
  id: {{ $json.id }},
  title: {{ $json.title }}
}