{"id":28902638,"url":"https://github.com/kumarharsh/node-freshdesk","last_synced_at":"2026-02-22T08:39:29.108Z","repository":{"id":27441338,"uuid":"30919529","full_name":"kumarharsh/node-freshdesk","owner":"kumarharsh","description":"A nodejs library for integrating Freshdesk with your backend.","archived":false,"fork":false,"pushed_at":"2017-01-05T19:08:37.000Z","size":16,"stargazers_count":6,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-07T17:56:21.020Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kumarharsh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-17T14:06:28.000Z","updated_at":"2017-09-19T13:06:29.000Z","dependencies_parsed_at":"2022-08-31T19:22:34.429Z","dependency_job_id":null,"html_url":"https://github.com/kumarharsh/node-freshdesk","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/kumarharsh/node-freshdesk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kumarharsh%2Fnode-freshdesk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kumarharsh%2Fnode-freshdesk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kumarharsh%2Fnode-freshdesk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kumarharsh%2Fnode-freshdesk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kumarharsh","download_url":"https://codeload.github.com/kumarharsh/node-freshdesk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kumarharsh%2Fnode-freshdesk/sbom","scorecard":{"id":573390,"data":{"date":"2025-08-11","repo":{"name":"github.com/kumarharsh/node-freshdesk","commit":"a21f53f0c78fcc511fdf6c6eafe94bf1a8ad9532"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Code-Review","score":2,"reason":"Found 4/16 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T16:58:30.647Z","repository_id":27441338,"created_at":"2025-08-20T16:58:30.647Z","updated_at":"2025-08-20T16:58:30.647Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29707060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-22T05:59:28.568Z","status":"ssl_error","status_checked_at":"2026-02-22T05:58:46.208Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-21T11:10:22.388Z","updated_at":"2026-02-22T08:39:29.063Z","avatar_url":"https://github.com/kumarharsh.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-freshdesk\n\n**WARNING**\n\n[![npm version](https://img.shields.io/badge/NPM-deprecated-red.svg)](https://github.com/maxkoryukov/node-freshdesk-api/issues/1)\n\nThis repository and corresponding NPM package are deprecated in favor of [**freshdesk-api**](https://www.npmjs.com/package/freshdesk-api).\n\nUseful links:\n\n1. [NPM package](https://www.npmjs.com/package/freshdesk-api):\n    * v2 is **preferred**: `npm install freshdesk-api`\n    * v1: `npm install freshdesk-api@APIv1`\n2. GitHub, `node-freshdesk-api`:\n    * [v2 on master branch](https://github.com/arjunkomath/node-freshdesk-api)\n    * [v1 in additional branch](https://github.com/arjunkomath/node-freshdesk-api/tree/API-v1)\n\n----\n\nA NodeJS library for integrating your backend with Freshdesk.\n\n[![npm version](https://badge.fury.io/js/freshdesk.svg)](https://badge.fury.io/js/freshdesk)\n\n# Install\n\n```\nnpm install freshdesk\n```\n\n# Usage\n\nYou'll need your API Key and the base url of your support portal handy for configuring the SDK. To get your API key, refer the [Freshdesk Docs](http://freshdesk.com/api#authentication).\n\n```\nvar _fd = require('freshdesk')\nvar Freshdesk = new _fd('http://mydomain.freshdesk.com', 'MyR4nD0MAp1KeY');\n\nFreshdesk.listTickets(function(err, res, body) {\n  console.log(\"The tickets are: \", body);\n});\n```\n\n# Supported Functions\n\nMost of the functions pertaining **Tickets** and **Users** are implemented. For unimplemented routes, you can use the raw routes, such as `Freshdesk.get()` to make the requests directly.\n\nHere are the currently supported functions. For a detailed explanation of the arguments you have to pass to each functions, refer to the [official docs](http://freshdesk.com/api).\n\n* **createTicket** (data \u003cobject\u003e, cb \u003cfunction\u003e)\n  method: post\n  url: `/helpdesk/tickets.json`,\n\n* **listTickets** (cb \u003cfunction\u003e)\n  method: get\n  url: `/helpdesk/tickets.json`\n\n* **allTickets** (cb \u003cfunction\u003e)\n  method: get\n  url: `/helpdesk/tickets/filter/all_tickets?format=json`\n\n* **getTicket** (id \u003cnumber\u003e, cb \u003cfunction\u003e)\n  method: get\n  url: `/helpdesk/tickets/#{id}.json`\n\n* **updateTicket** (id \u003cnumber\u003e, cb \u003cfunction\u003e)\n  method: put\n  url: `/helpdesk/tickets/#{id}.json`, data\n\n* **pickTicket** (id \u003cnumber\u003e, cb \u003cfunction\u003e)\n  method: put\n  url: `/helpdesk/tickets/#{id}/pick_tickets.json`, {}\n\n* **deleteTicket** (id \u003cnumber\u003e, cb \u003cfunction\u003e)\n  method: delete\n  url: `/helpdesk/tickets/#{id}.json`\n\n* **restoreTicket** (id \u003cnumber\u003e, cb \u003cfunction\u003e)\n  method: put\n  url: `/helpdesk/tickets/#{id}/restore.json`\n\n* **assignTicket** (id \u003cnumber\u003e, user_id \u003cfreshdesk_user_id\u003e, cb \u003cfunction\u003e)\n  method: put\n  url: `/helpdesk/tickets/#{id}/assign.json?responder_id=#{user_id}`\n\n* **ticketFields** (cb \u003cfunction\u003e)\n  method: get\n  url: `/ticket_fields.json`\n\n* **addNoteToTicket** (id \u003cnumber\u003e, note \u003cobject\u003e, cb \u003cfunction\u003e)\n  method: post\n  url: `/helpdesk/tickets/#{id}/conversations/note.json`\n\n* **createUser** (cb \u003cfunction\u003e)\n  method: post\n  url: `/contacts.json`, contact\n\n* **listUsers** (cb \u003cfunction\u003e)\n  method: get\n  url: `/contacts.json`state=all'\n\n* **updateUser** (id \u003cnumber\u003e, cb \u003cfunction\u003e)\n  method: put\n  url: `/contacts/#{id}.json`, data\n\n* **getUserByEmail** (email_id \u003cstring\u003e, cb \u003cfunction\u003e)\n  method: GET\n  url: `/contacts.json?state=all\u0026query=#{query}`\n\n# Examples\n\n### Get a Particular Ticket\n```\nFreshdesk.pickTicket(100, function(err, res) {\n  console.log(\"My Ticket is\", res.body);\n});\n```\n\n### Create a New TIcket\n```\nvar ticket = {\n  'helpdesk_ticket': {\n    'description': \"Hello, I'm an ephemeral ticket created from the API. I will be deleted as soon as my creator wishes so...\",\n    'subject': \"Efemeros\",\n    'email': 'efemeros@mailinator.com',\n    'priority': '1',\n    'status': '2',\n    'custom_field': {\n      // remove these comments, as they're not valid json\n      // any custom fields you'd have configured in your app...\n      // like:\n      // 'location_XXXXX': 'Tristan da Cunha'\n      // where XXXXX is a (possibly random) ID appended to your custom field\n      // This would most probably be different for each portal.\n    }\n  }\n};\nFreshdesk.createTicket(100, function(err, res) {\n  console.log(\"My Ticket is\", res.body);\n});\n```\n\n# Contributors\n\n* Angad Nadkarni (@angadn) - Support for HTML tickets (#3)\n* Scott Hasbrouck (@scotthasbrouck) - #1\n* Martin Edwards (@mledwards) - #2\n\n# Contributing\n\nIf you feel the need to add more functions, just fork this repo, add your functions and submit a PR. Wanna improve docs or the source, or even add tests? You're more than welcome :)\nThis is just a side project I created because I needed it, and the existing `node-freshdesk` [lacked some functions](https://github.com/capraconsulting/node-freshdesk/issues/2) which my project needed.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkumarharsh%2Fnode-freshdesk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkumarharsh%2Fnode-freshdesk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkumarharsh%2Fnode-freshdesk/lists"}