Help Scout

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

Credentials

helpScoutOAuth2Api (alias: @help)

CREDENTIAL @help = helpScoutOAuth2Api "My Help Scout"

Operations

Resource: conversation

create

Parameter	Type	Default	Details
mailboxId	options	""	required
status	options	""	required; active, closed, pending
subject	string	""	required
type	options	""	required; chat, email, phone
resolveData	boolean	true
additionalFields	collection	{}	keys: assignTo, autoReply, closedAt, createdAt, customerEmail, customerId, ...
threadsUi	fixedCollection	{}	groups: threadsValues

delete

Parameter	Type	Default	Details
conversationId	string	""	required

get

Parameter	Type	Default	Details
conversationId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
options	collection	{}	keys: assignTo, embed, folder, mailbox, modifiedSince, number, ...

Resource: customer

create

Parameter	Type	Default	Details
resolveData	boolean	true
additionalFields	collection	{}	keys: age, firstName, gender, jobTitle, lastName, location, ...
addressUi	fixedCollection	{}	groups: addressValue
chatsUi	fixedCollection	{}	groups: chatsValues
emailsUi	fixedCollection	{}	groups: emailsValues
phonesUi	fixedCollection	{}	groups: phonesValues
socialProfilesUi	fixedCollection	{}	groups: socialProfilesValues
websitesUi	fixedCollection	{}	groups: websitesValues

get

Parameter	Type	Default	Details
customerId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
options	collection	{}	keys: firstName, lastName, mailbox, modifiedSince, sortField, sortOrder, ...

properties

No additional parameters.

update

Parameter	Type	Default	Details
customerId	string	""
updateFields	collection	{}	keys: age, firstName, gender, jobTitle, lastName, location, ...

Resource: mailbox

get

Parameter	Type	Default	Details
mailboxId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

Resource: thread

create

Parameter	Type	Default	Details
conversationId	string	""	required
type	options	""	required; chat, customer, note, phone, reply
text	string	""	required
additionalFields	collection	{}	keys: createdAt, customerEmail, customerId, draft, imported
attachmentsUi	fixedCollection	{}	groups: attachmentsValues, attachmentsBinary

getAll

Parameter	Type	Default	Details
conversationId	string	""	required
returnAll	boolean	false
limit	number	50

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
assignTo	number	0
autoReply	boolean	false
closedAt	dateTime	""
createdAt	dateTime	""
customerEmail	string	""
customerId	number	0
imported	boolean	false
tags	multiOptions	[]
user	number	0

threadsUi children:

threadsValues group:

Parameter	Type	Default	Details
type	options	""	chat, customer, note, phone, reply
text	string	""
bcc	string	[]
cc	string	[]
draft	boolean	false

options children:

Parameter	Type	Default	Details
assignTo	number	0
embed	options	""	threads
folder	string	""
mailbox	string	""
modifiedSince	dateTime	""
number	number	0
query	string	""
sortField	options	""	createdAt, customerEmail, customerName, mailboxid, modifiedAt, number, score, status, ... (9 total)
sortOrder	options	"desc"	asc, desc
status	options	"active"	active, all, closed, open, pending, spam
tags	multiOptions	[]

addressUi children:

addressValue group:

Parameter	Type	Default	Details
line1	string	""
line2	string	""
city	string	""
state	string	""
country	options	""
postalCode	string	""

chatsUi children:

chatsValues group:

Parameter	Type	Default	Details
type	options	""	aim, gtalk, icq, msn, other, qq, skype, xmpp, ... (9 total)
value	string	""

emailsUi children:

emailsValues group:

Parameter	Type	Default	Details
type	options	""	home, other, work
value	string	""

phonesUi children:

phonesValues group:

Parameter	Type	Default	Details
type	options	""	fax, home, other, pager, work
value	string	""

socialProfilesUi children:

socialProfilesValues group:

Parameter	Type	Default	Details
type	options	""	aboutMe, facebook, flickr, forsquare, google, googleplus, linkedin, other, ... (12 total)
value	string	""

websitesUi children:

websitesValues group:

Parameter	Type	Default	Details
value	string	""

updateFields children:

Parameter	Type	Default	Details
age	number	1
firstName	string	""
gender	options	""	female, male, unknown
jobTitle	string	""
lastName	string	""
location	string	""
background	string	""
organization	string	""
photoUrl	string	""

attachmentsUi children:

attachmentsValues group:

Parameter	Type	Default	Details
fileName	string	""
mimeType	string	""
data	string	""

attachmentsBinary group:

Parameter	Type	Default	Details
property	string	"data"

Example

NODE "helpScout" @help AS "Help Scout" {
  resource: "conversation",
  operation: "get",
  subject: {{ $json.subject }},
  conversationId: {{ $json.conversationId }},
  customerId: {{ $json.customerId }}
}