![](\"https://resources.jetbrains.com/storage/products/company/brand/logos/WebStorm_icon.png\"/){kind=icon}
\n\n## Install\n\n```\nnpm install --save freshdesk-api\n```\n\nAlso, you could use **version 1 of API**, provided by Kumar Harsh [@kumarharsh], but this version is obsolete, and marked as _deprecated_:\n\n```shell\nnpm install freshdesk-api@APIv1\n```\n\n## Usage\n\n```javascript\nvar Freshdesk = require(\"freshdesk-api\");\nvar freshdesk = new Freshdesk(\"https://yourdomain.freshdesk.com\", \"yourApiKey\");\n```\n\nOr, with promises:\n\n```javascript\nvar Freshdesk = require(\"freshdesk-api\");\nvar Promise = require(\"bluebird\");\nvar asyncFreshdesk = Promise.promisifyAll(\n\tnew Freshdesk(\"https://yourdomain.freshdesk.com\", \"yourApiKey\")\n);\n\n// see usage examples\n```\n\n`bluebird` is not a dependency of this package, install it separately: `npm install bluebird`\n\n## Examples\n\n### Create a new ticket\n\n```javascript\nfreshdesk.createTicket(\n\t{\n\t\tname: \"test ticket\",\n\t\temail: \"test@test.com\",\n\t\tsubject: \"test sub\",\n\t\tdescription: \"test description\",\n\t\tstatus: 2,\n\t\tpriority: 1,\n\t},\n\tfunction (err, data) {\n\t\tconsole.log(err || data);\n\t}\n);\n```\n\n### Update a ticket\n\n```javascript\nfreshdesk.updateTicket(\n\t21,\n\t{\n\t\tdescription: \"updated description\",\n\t\tstatus: 2,\n\t\tpriority: 1,\n\t},\n\tfunction (err, data, extra) {\n\t\tconsole.log(err || data);\n\t}\n);\n```\n\n### Get a ticket\n\n```javascript\nfreshdesk.getTicket(21, function (err, data, extra) {\n\tconsole.log(err || data);\n});\n```\n\n### Delete a ticket\n\n```javascript\nfreshdesk.deleteTicket(21, function (err, data, extra) {\n\tconsole.log(err || data);\n});\n```\n\n### Ticket attachments\n\n```javascript\nfreshdesk.createTicket(\n\t{\n\t\tdescription: \"test description\",\n\t\tattachments: [\n\t\t\tfs.createReadStream(\"/path/to/file1.ext\"),\n\t\t\tfs.createReadStream(\"/path/to/file2.ext\"),\n\t\t],\n\t},\n\tfunction (err, data) {\n\t\tconsole.log(err || data);\n\t}\n);\n```\n\n### Get a ticket PROMISIfied\n\n_\\* for promisified version only_\n\n```javascript\nasyncFreshdesk.getTicketAsync(21)\n .then((data, extra) => {\n console.log(data, extra)\n })\n\n .catch(Freshdesk.FreshdeskError, err => {\n // typed `catch` exists only in bluebird\n\n console.log('ERROR OCCURED', err)\n })\n})\n\n```\n\n## Testing & mocking\n\nNote that `node-freshdesk-api` is using [Undici](https://github.com/nodejs/undici) as an HTTP client, which is not based on Node.js `net` module. As a result, it is not compatible with popular `nock` mocking library. When mocking `node-freshdesk-api` interactions, make sure to use built-in Undici [mocking functionality](https://github.com/nodejs/undici/blob/main/docs/api/MockPool.md).\n\nAlternatively, you can use tests of `node-freshdesk-api` itself as an example.\n\nThe only exception are forms with attachments (field `attachments` is set and is an array) - these requests are handled using `form-data` library, use `net` module and need to be mocked with `nock`.\n\nYou can also use a mock server (such as [Pactum](https://github.com/pactumjs/pactum)) for completely client-agnostic server mocking. \n\n## Use with Webpack\n\nHere is a part of `webpack.config`:\n\n```js\nwebpackConfig.node = {\n\t// ...\n\n\tconsole: true,\n\tfs: \"empty\",\n\tnet: \"empty\",\n\ttls: \"empty\",\n\n\t// ...\n};\n```\n\nA little bit more [about webpack here](https://github.com/arjunkomath/node-freshdesk-api/issues/43)\n\n## Callback\n\nEvery SDK method receives a `callback` parameter. It is a function, which will be called on Freshdesk response received.\n\nCallback called with following arguments:\n\n- `err` - `Error` instance (if occured) or `null`\n- `data` - `object`. Freshdesk response, an object, parsed from JSON\n- `extra` - additional data, gathered from response. For example, information about paging\n\n### extra parameter\n\n`extra` is an object with following fields:\n\n- `pageIsLast` - indicates, that the response is generated from the last page, and there is no sense to play with `page` and `per_page` parameters. This parameter is useful for `listXXX` methods, called with pagination\n- `requestId` - value of `x-request-id` header from API response\n\n## Extended/debugging output\n\nTo enable debug info, run your program with environment flags\n\n- on linux\n ```bash\n $ DEBUG=freshdesk-api nodejs NAME-OF-YOUR-SCRIPT.js\n ```\n\n## Functions and Responses\n\n### Tickets\n\n- **createTicket(ticket, callback)** - Create a new ticket, list of [parameters](http://developer.freshdesk.com/api/#create_ticket)\n- **getTicket(id, callback)** - Get a ticket by its id\n- **updateTicket(id, ticket, callback)** - Update a ticket by its id, list of [parameters](http://developer.freshdesk.com/api/#update_ticket)\n- **deleteTicket(id, callback)** - Delete a ticket by its id\n- **restoreTicket(id, callback)** - Restore a ticket by its id\n- **listAllTickets(filter, callback)** - List All Tickets, check list of [filters](http://developer.freshdesk.com/api/#list_all_tickets)\n- **filterTickets(query, page, callback)** - Filter tickets, based on ticket fields, [read more](https://developer.freshdesk.com/api/#filter_tickets)\n- **listAllTicketFields(callback)** - List All Ticket Fields\n- **listAllConversations(id, callback)** - List All Conversations of a Ticket by its id\n- **listAllTicketTimeEntries(id, callback)** - List All Time Entries of a Ticket by its id\n- **listAllSatisfactionRatings** - **NOT IMPLEMENTED** http://developers.freshdesk.com/api/#view_ticket_satisfaction_ratings\n\n### Conversations\n\n- **createReply(id, reply, callback)** - Create a Reply for a ticket by its id, list of [parameters](http://developer.freshdesk.com/api/#reply_ticket)\n- **createNote(id, note, callback)** - Create a Note for a ticket by its id, list of [parameters](http://developer.freshdesk.com/api/#add_note_to_a_ticket)\n- **updateConversation(id, conversation, callback)** - Update a conversation by its id, list of [parameters](http://developer.freshdesk.com/api/#update_conversation)\n- **deleteConversation(id, callback)** - Delete a conversation by its id\n\n### Contacts\n\n- **createContact(contact, callback)** - Create a new contact, list of [parameters](http://developer.freshdesk.com/api/#create_contact)\n- **getContact(id, callback)** - Get a contact by its id\n- **updateContact(id, contact, callback)** - Update a contact by its id, list of [parameters](http://developer.freshdesk.com/api/#update_contact)\n- **deleteContact(id, callback)** - Delete a contact by its id\n- **listAllContacts(filter, callback)** - List All Contact, check list of [filters](http://developer.freshdesk.com/api/#list_all_contacts)\n- **listAllContactFields(callback)** - List All Contact Fields\n- **makeAgent(id, callback)** - Make a contact an Agent, [read more](http://developer.freshdesk.com/api/#make_agent)\n- **filterContacts(query, callback)** - Filter contacts (beta), based on contact fields, [read more](http://developers.freshdesk.com/api/#filter_contacts)\n\n### Agents\n\n- **getAgent(id, callback)** - Get agent by ID [read more](https://developer.freshdesk.com/api/#view_agent)\n- **listAllAgents(params, callback)** - List all agents [read more](https://developer.freshdesk.com/api/#list_all_agents)\n- **updateAgent(id, data, callback)** - Update an agent by ID [read more](https://developer.freshdesk.com/api/#update_agent)\n- **deleteAgent(id, callback)** - Delete an agent by ID [read more](https://developer.freshdesk.com/api/#delete_agent)\n- **currentAgent(callback)** - Currently Authenticated Agent[read more](https://developer.freshdesk.com/api/#me)\n\n### Roles\n\n- **getRole(id, callback)** - View a Role\n- **listAllRoles(callback)** - List All Roles\n\n### Groups\n\nNot implemented: http://developers.freshdesk.com/api/#groups\n\n### Companies\n\n- **createCompany(data, callback)** - Create a new company record using [parameters](http://developers.freshdesk.com/api/#create_company)\n- **getCompany(id, callback)** - Get company by ID; [read more](http://developers.freshdesk.com/api/#view_company)\n- **searchCompany(params, callback)** - Get company by name; [read more](https://developers.freshdesk.com/api/#search_companies)\n- **listAllCompanies(params, callback)** - List all companies; [parameters](http://developers.freshdesk.com/api/#list_all_companies)\n- **updateCompany(id, data, callback)** - Update a company by ID; [parameters](http://developers.freshdesk.com/api/#update_company)\n- **deleteCompany(id, callback)** - Delete a company by ID, [read more](http://developers.freshdesk.com/api/#delete_company)\n- **filterCompanies(query, callback)** - Filter companies (beta), based on company fields, [read more](http://developers.freshdesk.com/api/#filter_companies)\n- **listAllCompanyFields(callback)** - List All Company Fields\n\n### Discussions\n\nNot implemented: http://developers.freshdesk.com/api/#discussions\n\n### Solutions\n\n- **createSolutionCategory(data, cb)** - Create a Solution Category [parameters](https://developer.freshdesk.com/api/#create_solution_category)\n- **createTranslatedSolutionCategory(id, language_code, data, cb)** - Create a translated solution category [parameters](https://developer.freshdesk.com/api/#create_solution_category)\n- **updateSolutionCategory(id, data, cb)** - Update a Solution Category [parameters](https://developer.freshdesk.com/api/#update_solution_category)\n- **updateTranslatedSolutionCategory(id, language_code, data, cb)** - Update a translated solution category [parameters](https://developer.freshdesk.com/api/#update_solution_category)\n- **getSolutionCategory(id, cb)** - View a Solution Category [parameters](https://developer.freshdesk.com/api/#view_solution_category)\n- **listAllSolutionCategories(cb)** - List all Solution Categories [parameters](https://developer.freshdesk.com/api/#list_all_solution_categories)\n- **deleteSolutionCategory(id, cb)** - Delete a Solution Category [parameters](https://developer.freshdesk.com/api/#delete_solution_category)\n- **createSolutionFolder(id, data, cb)** - Create a Solution Folder [parameters](https://developer.freshdesk.com/api/#create_solution_folder)\n- **createTranslatedSolutionFolder(id, language_code, data, cb)** - Create a translated solution folder [parameters](https://developer.freshdesk.com/api/#create_solution_folder)\n- **updateSolutionFolder(id, data, cb)** - Update a Solution Folder [parameters](https://developer.freshdesk.com/api/#update_solution_folder)\n- **updateTranslatedSolutionFolder(id, language_code, data, cb)** - Update a translated solution folder [parameters](https://developer.freshdesk.com/api/#update_solution_folder)\n- **getSolutionFolder(id, cb)** - View a Solution Folder [parameters](https://developer.freshdesk.com/api/#view_solution_folder)\n- **listAllSolutionCategoryFolders(id, cb)** - List all Solution Folders in a Category [parameters](https://developer.freshdesk.com/api/#list_all_solution_folders)\n- **deleteSolutionFolder(id, cb)** - Delete a Solution Folder [parameters](https://developer.freshdesk.com/api/#delete_solution_folder)\n- **createSolutionArticle(id, data, cb)** - Create a Solution Article [parameters](https://developer.freshdesk.com/api/#create_solution_article)\n- **createTranslatedSolutionArticle(id, language_code, data, cb)** - Create a translated solution article [parameters](https://developer.freshdesk.com/api/#create_solution_article)\n- **updateSolutionArticle(id, data, cb)** - Update a Solution Article [parameters](https://developer.freshdesk.com/api/#update_solution_article)\n- **updateTranslatedSolutionArticle(id, language_code, data, cb)** - Update a translated solution article [parameters](https://developer.freshdesk.com/api/#update_solution_article)\n- **getSolutionArticle(id, cb)** - View a Solution Article [parameters](https://developer.freshdesk.com/api/#view_solution_article)\n- **listAllSolutionFolderArticles(id, cb)** - List all Solution Articles in a Folder [parameters](https://developer.freshdesk.com/api/#list_all_solution_articles)\n- **deleteSolutionArticle(id, cb)** - Delete a Solution Article [parameters](https://developer.freshdesk.com/api/#delete_solution_article)\n- **searchSolutionArticles(term, cb)** - Search solution articles [parameters](https://developer.freshdesk.com/api/#search_solution_article)\n\n### Surveys\n\nNot implemented: http://developers.freshdesk.com/api/#surveys\n\n### Satisfaction Ratings\n\nNot implemented: http://developers.freshdesk.com/api/#satisfaction-ratings\n\n### Time Entries\n\n- **createTimeEntry(ticketID, data, callback)** - Create new ticket [read more](https://developer.freshdesk.com/api/#create_time_entry)\n- **listAllTimeEntries(params, callback)** - Lists all time entries, if no params pass 'null' [read more](https://developer.freshdesk.com/api/#list_all_time_entries)\n- **updateTimeEntry(entryID, data, callback)** - Update a time entry by ID [read more](https://developer.freshdesk.com/api/#update_time_entry)\n- **toggleTimer(entryID, callback)** - Toggle timer on time entry by ID [read more](https://developer.freshdesk.com/api/#toggle_time_entry)\n- **deleteTimeEntry(id, callback)** - Deletes a time entry by ID [read more](https://developer.freshdesk.com/api/#delete_time_entry)\n\n### Email Configs\n\nNot implemented: http://developers.freshdesk.com/api/#email-configs\n\n### Products\n\nNot implemented: http://developers.freshdesk.com/api/#products\n\n### Business Hours\n\nNot implemented: http://developers.freshdesk.com/api/#business-hours\n\n### SLA Policies\n\nSLA = service level agreement\n\nNot implemented: http://developers.freshdesk.com/api/#sla-policies\n\n### Settings\n\n- **getSettings(callback)** - View Helpdesk Settings [read more](http://developers.freshdesk.com/api/#settings)\n\n## License\n\nSee the [LICENSE](https://github.com/arjunkomath/node-freshdesk-api/blob/master/LICENSE) file for license rights and limitations (MIT).\n\n[email:arjunkomath]: mailto:arjunkomath@gmail.com\n[@maxkoryukov]: https://www.npmjs.com/~maxkoryukov\n[@kumarharsh]: https://github.com/kumarharsh\n[@davinthesmith]: https://github.com/davinthesmith\n[@velua]: http://jjs.life\n[@roniger]: https://github.com/roniger\n\n## Contributors β¨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n![\"Arjun](\"https://avatars.githubusercontent.com/u/2555067?v=4?s=100\") Arjun Komath π» π β οΈ | \n ![\"Maksim](\"https://avatars.githubusercontent.com/u/8887971?v=4?s=100\") Maksim Koryukov π» π β οΈ | \n ![\"DMehaffy\"/](\"https://avatars.githubusercontent.com/u/8593673?v=4?s=100\") DMehaffy π» π β οΈ | \n ![\"John](\"https://avatars.githubusercontent.com/u/8017434?v=4?s=100\") John Williamson π» π | \n ![\"Wouter](\"https://avatars.githubusercontent.com/u/5398059?v=4?s=100\") Wouter van der Neut π» π β οΈ | \n ![\"JuliΓ‘n](\"https://avatars.githubusercontent.com/u/733877?v=4?s=100\") JuliΓ‘n Duque π» | \n ![\"Michael](\"https://avatars.githubusercontent.com/u/2154482?v=4?s=100\") Michael Lambert π» π β οΈ | \n
![\"Pongstr\"/](\"https://avatars.githubusercontent.com/u/962502?v=4?s=100\") Pongstr π» | \n ![\"Igor](\"https://avatars.githubusercontent.com/u/1847934?v=4?s=100\") Igor Savin π» | \n ![\"jae](\"https://avatars.githubusercontent.com/u/224587?v=4?s=100\") jae kaplan π» | \n ![\"Kumar](\"https://avatars.githubusercontent.com/u/760112?v=4?s=100\") Kumar Harsh π» | \n ![\"roniger\"/](\"https://avatars.githubusercontent.com/u/961431?v=4?s=100\") roniger π» π β οΈ | \n ![\"Mohamed](\"https://avatars.githubusercontent.com/u/35629390?v=4?s=100\") Mohamed Ahmed π» | \n