Developer API’S

HelpSpot’s series of robust API’s allow for full integration with external systems. Allowing you to easily view customer data within the HelpSpot interface, programmatically create requests, and even access request queues from outside the application.

Integrate customer information with HelpSpot

Live Lookup

Unlike other systems, HelpSpot doesn’t require you to syncronize your customer data but instead allows for real time access.

Staff can easily access your customer data systems (CRM, HRM, Active Directory, LDAP) directly from HelpSpot’s request page without the worry of maintaining the same data in separate locations. Return any data you like and even set HelpSpot field values with the click of a button.

Web Services

The most robust of our API’s, our web services API provides access to nearly all data stored within the system. HTTP-based returning XML/JSON/PHP for easy access from nearly every programming language. This API can be used to programmatically create requests, view queues from other applications, access forums and knowledge book content, embed your help desk directly into your web site/software, or even create an entire new help desk interface. Possible uses are infinite and can be tailored to fit your exact business need.

Sitepen created a completely custom UI for their support team. Audiofile Engineering has deeply integrated HelpSpot into their desktop applications.

 

Request Push

Send an individual request from HelpSpot to another system. Most commonly used to push individual requests into a software bug tracker for further work, request data can be pushed to any system for other uses.

Pushes can also be initiated from automation rules, allowing pushes to happen automatically based on requests meeting a particular set of conditions.

Email Parser

If you already have forms that generate emails or need to then HelpSpot’s email parser can accept those emails to create requests and set field values. Using a simple tagging option, emails can set categories, assignment and even custom fields.

Helper Libraries

Several libraries are available to kick start your use of the web services API. Our own PHP library as well as customer contributed libraries for Ruby, Python and Cocoa.

Complete Documentation

All our API’s are fully documented in the API manual.

More to Know

  • HTTP - HelpSpot’s API’s are HTTP based making them easy to use from any programming language.
  • XML/JSON/PHP - Get return values in the format that works best for you.
  • Integration - Live Lookup lets you integrate your data instead of duplicate it.
  • Push - Finally a help desk tool that works with your bug tracker and doesn’t try to replace it.
  • Email forms - Use existing email forms with HelpSpot’s powerful email parser.
  • Seamless - Build forms in your intranet/website/application that generate requests within HelpSpot
  • More than requests - Retrieve knowledge pages and forum topics/posts.