@robinpath/freshdesk
v0.3.0
Published
Freshdesk API v2 — tickets, notes, conversations, and customer support automation. Uses the encrypted credential vault (HTTP Basic with API key).
Readme
@robinpath/freshdesk
Freshdesk module for RobinPath.
Why use this module?
The freshdesk module lets you:
- listTickets
- getTicket
- createTicket
- updateTicket
- deleteTicket
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
robinpath add @robinpath/freshdeskQuick Start
1. Set up credentials
freshdesk.setCredentials "your-credentials"2. listTickets
freshdesk.listTicketsAvailable Functions
| Function | Description |
|----------|-------------|
| freshdesk.setCredentials | Configure freshdesk credentials. |
| freshdesk.listTickets | listTickets |
| freshdesk.getTicket | getTicket |
| freshdesk.createTicket | createTicket |
| freshdesk.updateTicket | updateTicket |
| freshdesk.deleteTicket | deleteTicket |
| freshdesk.listTicketConversations | listTicketConversations |
| freshdesk.replyToTicket | replyToTicket |
| freshdesk.addNoteToTicket | addNoteToTicket |
| freshdesk.listContacts | listContacts |
| freshdesk.getContact | getContact |
| freshdesk.createContact | createContact |
| freshdesk.updateContact | updateContact |
| freshdesk.deleteContact | deleteContact |
| freshdesk.listAgents | listAgents |
| freshdesk.getAgent | getAgent |
| freshdesk.listGroups | listGroups |
| freshdesk.listCompanies | listCompanies |
| freshdesk.createCompany | createCompany |
| freshdesk.searchTickets | searchTickets |
| freshdesk.filterTickets | filterTickets |
Examples
listTickets
freshdesk.listTicketsgetTicket
freshdesk.getTicketcreateTicket
freshdesk.createTicketIntegration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/freshdesk";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
freshdesk.setCredentials "your-credentials"
freshdesk.listTickets
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/hubspot— HubSpot module for complementary functionality@robinpath/salesforce— Salesforce module for complementary functionality@robinpath/pipedrive— Pipedrive module for complementary functionality@robinpath/intercom— Intercom module for complementary functionality@robinpath/zoho— Zoho module for complementary functionality
License
MIT
