npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-freshdesk

v0.1.1

Published

Simplify nodeJS integration with Freshdesk

Downloads

30

Readme

node-freshdesk

A small node module that helps integration your application with FreshDesk. There is still several API endpoints with FreshDesk that is not implemented in this implementation. Feel free to fork and make pull requests, or adding issues as you please.

Install

npm install node-freshdesk

Usage

After having installed it, simply require it, set it up with your own url and API-key, and start calling methods!

var freshdeskAPI = require('node-freshdesk');
var freshdesk = new freshdeskAPI(
  'http://yourcompanyname.freshdesk.com',
  'YourAwesomeAPIKeyThatsQuiteLong');

freshdesk.callMethods();

Functions and responses

| Functions | Returns to callback | Explanation | | ---------------- | ---------------- | ---------------- | | get (link, callback) | callback(err, res, body) | Base function for using get on FreshDesk API. Can be used if non-implemented API call needed. | | put (link, data, callback) | callback(err, res, body)| Base function for using put on FreshDesk API. Can be used if non-implemented API call needed. | | post (link, data, callback) | callback(err, res, body) | Base function for using post on FreshDesk API. Can be used if non-implemented API call needed. | | postTicket (ticket, callback) | callback(err, res, body) | Posts a single Ticket | | putTicket (id, ticket, callback) | callback(err, res, body) | Updates a ticket by id. | | getTickets (callback) | callback(err, res, body) | Provides all tickets. | | getTicket (id, callback) | callback(err, res, body) | Provides single ticket. | | postNoteToTicket (id, note, is_private, callback) | callback(err, res, body) | Posts a note (update-event) on a ticket. set is_private to true if you do not wish the requestor to be able to read the comment | | postContact (contact, callback) | callback(err, res, body) | Adds a contact | | putContact (id, contact, callback) | callback(err, res, body) | Updates a contact | | getContacts (callback) | callback(err, res, body) | Provides all contacts (that are not deleted)| | getContactByEmail (email, callback) | callback(contact) | Provides single contact if it exists, and is not deleted. Else it returns null. |

Examples

Posting a new ticket

var example_ticket = {
  'helpdesk_ticket': {
    'description':'A totally rad description of a what the problem is',
    'subject':'Something like "Cannot log in"',
    'email': '[email protected]',
  }
};

freshdesk.postTicket(
  example_ticket,
  function(err, res, body) {
    if (err)
      console.log('something is not right');
    else {
      console.log('We got a ticket posted to FreshyFresh, it is right here in the body:');
      console.log(body)
    }
  }
);

Editing an existing ticket

var ticketupdate = {
  'helpdesk_ticket': {
    'description':'A new description.',
    'status': 3,
    }
};

freshdesk.putTicket(12, ticketupdate, function(err, res, body) {
  // Handle the callback.
}

Retrieving a user

freshdesk.getContactByEmail('[email protected]', function(user) {
  if (user === null)
    console.log('we did not find your user');
  else {
    console.log('We got you, man!');
    console.log(user);
  }
});