Skip to content

Freshdesk

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

Credentials

freshdeskApi (alias: @freshdesk)

CREDENTIAL @freshdesk = freshdeskApi "My Freshdesk"

Operations

Resource: contact

create

Parameter Type Default Details
name string "" required
email string ""
additionalFields collection {} keys: address, company_id, customFields, description, email, job_title, ...

delete

Parameter Type Default Details
contactId string "" required

get

Parameter Type Default Details
contactId string "" required

getAll

Parameter Type Default Details
filters collection {} keys: company_id, email, mobile, phone, state, updated_since

update

Parameter Type Default Details
contactId string "" required
additionalFields collection {} keys: address, company_id, customFields, description, email, job_title, ...

Resource: ticket

create

Parameter Type Default Details
requester options "requesterId" required; email, facebookId, phone, requesterId, twitterId, uniqueExternalId
requesterIdentificationValue string "" required
status options "pending" required; closed, open, pending, resolved
priority options "low" required; low, medium, high, urgent
source options "portal" required; chat, email, feedbackWidget, mobileHelp, OutboundEmail, phone, portal
options collection {} keys: agent, ccEmails, company, description, dueBy, emailConfigId, ...

delete

Parameter Type Default Details
ticketId string "" required

get

Parameter Type Default Details
ticketId string "" required

getAll

Parameter Type Default Details
returnAll boolean false
limit number 5
options collection {} keys: companyId, include, order, orderBy, requesterEmail, requesterId, ...

update

Parameter Type Default Details
ticketId string "" required
updateFields collection {} keys: agent, ccEmails, company, dueBy, emailConfigId, frDueBy, ...

Parameter Details

options children:

Parameter Type Default Details
agent options ""
ccEmails string ""
company options ""
description string ""
dueBy dateTime ""
emailConfigId number ""
frDueBy dateTime ""
group options ""
name string ""
product options ""
subject string ""
tags string ""
type options "Question" Feature Request, Incident, Problem, Question, Refund

updateFields children:

Parameter Type Default Details
agent options ""
ccEmails string ""
company options ""
dueBy dateTime ""
emailConfigId number ""
frDueBy dateTime ""
group options ""
name string ""
product options ""
priority options "low" low, medium, high, urgent
requester options "requesterId" email, facebookId, phone, requesterId, twitterId, uniqueExternalId
requesterIdentificationValue string ""
status options "pending" open, pending, resolved, closed
source options "portal" chat, email, feedbackWidget, mobileHelp, OutboundEmail, phone, portal
tags string ""
type options "Question" Feature Request, Incident, Problem, Question, Refund

additionalFields children:

Parameter Type Default Details
address string ""
company_id number ""
customFields fixedCollection [] groups: customField
description string ""
email string ""
job_title string ""
language string ""
mobile string ""
name string ""
other_companies string []
other_emails string []
phone string ""
tags string []
time_zone string ""
twitter_id string ""
unique_external_id string ""
view_all_tickets boolean false

filters children:

Parameter Type Default Details
company_id number ""
email string ""
mobile string ""
phone string ""
state options "" blocked, deleted, unverified, verified
updated_since dateTime ""

Example

NODE "freshdesk" @freshdesk AS "Freshdesk" {
  resource: "contact",
  operation: "get",
  requesterIdentificationValue: {{ $json.requesterIdentificationValue }},
  ticketId: {{ $json.ticketId }},
  name: {{ $json.name }}
}