Zendesk

Zendesk module for RobinPath.

Package: @robinpath/zendesk | Category: Utility | Type: Utility

Authentication

zendesk.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 zendesk module when you need to:

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

Quick Reference

Function	Description	Returns
setCredentials	Configure zendesk credentials.	object
listTickets	listTickets	object
getTicket	getTicket	object
createTicket	createTicket	object
updateTicket	updateTicket	object
deleteTicket	deleteTicket	object
listTicketComments	listTicketComments	object
addTicketComment	addTicketComment	object
listUsers	listUsers	object
getUser	getUser	object
createUser	createUser	object
updateUser	updateUser	object
searchTickets	searchTickets	object
listOrganizations	listOrganizations	object
getOrganization	getOrganization	object
createOrganization	createOrganization	object
listGroups	listGroups	object
assignTicket	assignTicket	object
listViews	listViews	object
listMacros	listMacros	object
getSatisfactionRatings	getSatisfactionRatings	object
getTicketMetrics	getTicketMetrics	object
mergeTickets	mergeTickets	object

Functions

setCredentials

Configure zendesk credentials.

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

zendesk.setCredentials

Parameter	Type	Required	Description
subdomain	string	Yes	subdomain
email	string	Yes	email
apiToken	string	Yes	apiToken

---

listTickets

listTickets

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

zendesk.listTickets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getTicket

getTicket

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

zendesk.getTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTicket

createTicket

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

zendesk.createTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateTicket

updateTicket

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

zendesk.updateTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteTicket

deleteTicket

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

zendesk.deleteTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTicketComments

listTicketComments

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

zendesk.listTicketComments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addTicketComment

addTicketComment

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

zendesk.addTicketComment

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listUsers

listUsers

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

zendesk.listUsers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUser

getUser

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

zendesk.getUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createUser

createUser

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

zendesk.createUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateUser

updateUser

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

zendesk.updateUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchTickets

searchTickets

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

zendesk.searchTickets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listOrganizations

listOrganizations

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

zendesk.listOrganizations

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getOrganization

getOrganization

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

zendesk.getOrganization

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createOrganization

createOrganization

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

zendesk.createOrganization

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listGroups

listGroups

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

zendesk.listGroups

Parameter	Type	Required	Description
input	string	No	Input parameter

---

assignTicket

assignTicket

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

zendesk.assignTicket

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listViews

listViews

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

zendesk.listViews

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listMacros

listMacros

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

zendesk.listMacros

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getSatisfactionRatings

getSatisfactionRatings

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

zendesk.getSatisfactionRatings

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getTicketMetrics

getTicketMetrics

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

zendesk.getTicketMetrics

Parameter	Type	Required	Description
input	string	No	Input parameter

---

mergeTickets

mergeTickets

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

zendesk.mergeTickets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Zendesk API error (${res.status}): ${t}	Check the error message for details
zendesk.setCredentials requires subdomain, email, apiToken.	Check the error message for details
zendesk.updateTicket requires an ID.	Check the error message for details
zendesk.deleteTicket requires an ID.	Check the error message for details
zendesk.updateUser requires an ID.	Check the error message for details
zendesk.mergeTickets requires an ID.	Check the error message for details
Zendesk: "..." not configured. Call zendesk.setCredentials first.	Check the error message for details

@desc "List tickets and validate result"
do
  set $result as zendesk.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
  zendesk.setCredentials $token
enddo

@desc "List tickets and iterate results"
do
  set $result as zendesk.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
  zendesk.setCredentials $token
enddo

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

3. Create and update workflow

Create an item and then update it.

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

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

4. Check before creating

List existing items and only create if needed.

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

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

5. Multi-step Zendesk workflow

Chain multiple zendesk operations together.

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

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

6. Safe listTickets with validation

Check results before proceeding.

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

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

Related Modules

• json -- JSON module for complementary functionality