Freshdesk

Freshdesk module for RobinPath.

Package: @robinpath/freshdesk | Category: Crm | Type: Integration

Authentication

freshdesk.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the freshdesk module when you need to:

• listTickets -- Use freshdesk.listTickets to perform this operation
• getTicket -- Use freshdesk.getTicket to perform this operation
• createTicket -- Use freshdesk.createTicket to perform this operation
• updateTicket -- Use freshdesk.updateTicket to perform this operation
• deleteTicket -- Use freshdesk.deleteTicket to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure freshdesk credentials.	object
listTickets	listTickets	object
getTicket	getTicket	object
createTicket	createTicket	object
updateTicket	updateTicket	object
deleteTicket	deleteTicket	object
listTicketConversations	listTicketConversations	object
replyToTicket	replyToTicket	object
addNoteToTicket	addNoteToTicket	object
listContacts	listContacts	object
getContact	getContact	object
createContact	createContact	object
updateContact	updateContact	object
deleteContact	deleteContact	object
listAgents	listAgents	object
getAgent	getAgent	object
listGroups	listGroups	object
listCompanies	listCompanies	object
createCompany	createCompany	object
searchTickets	searchTickets	object
filterTickets	filterTickets	object

Functions

setCredentials

Configure freshdesk credentials.

Module: freshdesk | Returns: object -- API response.

freshdesk.setCredentials

Parameter	Type	Required	Description
domain	string	Yes	domain
apiKey	string	Yes	apiKey

---

listTickets

listTickets

Module: freshdesk | Returns: object -- API response.

freshdesk.listTickets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getTicket

getTicket

Module: freshdesk | Returns: object -- API response.

freshdesk.getTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTicket

createTicket

Module: freshdesk | Returns: object -- API response.

freshdesk.createTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateTicket

updateTicket

Module: freshdesk | Returns: object -- API response.

freshdesk.updateTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteTicket

deleteTicket

Module: freshdesk | Returns: object -- API response.

freshdesk.deleteTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTicketConversations

listTicketConversations

Module: freshdesk | Returns: object -- API response.

freshdesk.listTicketConversations

Parameter	Type	Required	Description
input	string	No	Input parameter

---

replyToTicket

replyToTicket

Module: freshdesk | Returns: object -- API response.

freshdesk.replyToTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addNoteToTicket

addNoteToTicket

Module: freshdesk | Returns: object -- API response.

freshdesk.addNoteToTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listContacts

listContacts

Module: freshdesk | Returns: object -- API response.

freshdesk.listContacts

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getContact

getContact

Module: freshdesk | Returns: object -- API response.

freshdesk.getContact

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createContact

createContact

Module: freshdesk | Returns: object -- API response.

freshdesk.createContact

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateContact

updateContact

Module: freshdesk | Returns: object -- API response.

freshdesk.updateContact

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteContact

deleteContact

Module: freshdesk | Returns: object -- API response.

freshdesk.deleteContact

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listAgents

listAgents

Module: freshdesk | Returns: object -- API response.

freshdesk.listAgents

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAgent

getAgent

Module: freshdesk | Returns: object -- API response.

freshdesk.getAgent

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listGroups

listGroups

Module: freshdesk | Returns: object -- API response.

freshdesk.listGroups

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCompanies

listCompanies

Module: freshdesk | Returns: object -- API response.

freshdesk.listCompanies

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createCompany

createCompany

Module: freshdesk | Returns: object -- API response.

freshdesk.createCompany

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchTickets

searchTickets

Module: freshdesk | Returns: object -- API response.

freshdesk.searchTickets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

filterTickets

filterTickets

Module: freshdesk | Returns: object -- API response.

freshdesk.filterTickets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Freshdesk API error (${res.status}): ${t}	Check the error message for details
freshdesk.setCredentials requires domain, apiKey.	Check the error message for details
freshdesk.updateTicket requires an ID.	Check the error message for details
freshdesk.deleteTicket requires an ID.	Check the error message for details
freshdesk.updateContact requires an ID.	Check the error message for details
freshdesk.deleteContact requires an ID.	Check the error message for details
Freshdesk: "..." not configured. Call freshdesk.setCredentials first.	Check the error message for details

@desc "List tickets and validate result"
do
  set $result as freshdesk.listTickets
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Tickets

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  freshdesk.setCredentials $token
enddo

@desc "List tickets and iterate results"
do
  set $result as freshdesk.listTickets
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createTicket

Create a new resource and capture the result.

@desc "Setup authentication"
do
  freshdesk.setCredentials $token
enddo

@desc "Create ticket"
do
  set $result as freshdesk.createTicket
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  freshdesk.setCredentials $token
enddo

@desc "Create ticket and update ticket"
do
  set $created as freshdesk.createTicket
  # Update the created item
  freshdesk.updateTicket
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  freshdesk.setCredentials $token
enddo

@desc "List tickets and create ticket"
do
  set $existing as freshdesk.listTickets
  if $existing == null
    freshdesk.createTicket
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Freshdesk workflow

Chain multiple freshdesk operations together.

@desc "Setup authentication"
do
  freshdesk.setCredentials $token
enddo

@desc "List tickets, get ticket, and more"
do
  set $r_listTickets as freshdesk.listTickets
  set $r_getTicket as freshdesk.getTicket
  set $r_createTicket as freshdesk.createTicket
  print "All operations complete"
enddo

6. Safe listTickets with validation

Check results before proceeding.

@desc "Setup authentication"
do
  freshdesk.setCredentials $token
enddo

@desc "List tickets and validate result"
do
  set $result as freshdesk.listTickets
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• hubspot -- HubSpot module for complementary functionality
• salesforce -- Salesforce module for complementary functionality
• pipedrive -- Pipedrive module for complementary functionality
• intercom -- Intercom module for complementary functionality
• zoho -- Zoho module for complementary functionality