Overview
Quick Tour Provide faster and better support for your customers.
Get a Demo See HappyFox Helpdesk in action.
Features
Ticketing System Deliver exceptional customer service with HappyFox.
Knowledge Base Promote self-service; build help and FAQ pages.
Canned Actions Respond faster using templated responses and actions.
Automation Reduce the time spent on repetitive tasks.
Task Management Create and manage all the tasks involved in resolving a ticket.
Asset Management Track hardware and software assets in one place.
Help Desk Reports Monitor, refine and improve your customer engagement.
By Use Case
Help Desk Software Track requests from multiple channels in a single place.
Ticketing System Deliver exceptional customer service with HappyFox.
IT Help Desk Software The best helpdesk software for modern IT teams
Email Management Provide support via email without cluttering your inbox.
Customer Service A customer service management software that promises retention
Shared Inbox Organize, collaborate & measure your high-volume shared inboxes
Multi-Brand Help Desk Provide centralized support for multiple brands
Contact Center Software Omnichannel support for your cloud contact center
Resources
E-books & Guides Resources to reinvent your customer service experience.
Webinars Learn how to make the most of HappyFox products.
Case Studies Thousands of great companies call HappyFox a great friend.
Videos Checkout our library of educational videos.
Support Center What can we help you with? Talk to our customer support.
Blog Learn tips, stories, and new techniques.
API Technical Reference
The API provided by the Helpdesk is a RESTful web service. It supports operations like creating a ticket, adding updates to a ticket, listing tickets and users of the Helpdesk, etc. It supports JSON, Form Urlencoded and Multipart Form Data formats.
The API requires following skills in any programming language.
The documentation indicates parameters that need to be replaced with actual values using the format . The entire string including the enclosing < and > should be replaced.
For example: if the parameter is
The API requires a "API Key" and "Auth Code" pair for access. Contact the Helpdesk Admin for access details.
The server uses HTTP Basic Authentication with the "API Key" as username and "Auth Code" as the password. The authentication realm is "Basic".
The API server returns HTTP response code 401 in case of authorization required or login failure.
Credentials are passed as plain-text in HTTP Basic Authentication, therefore it is recommended to use SSL/TLS if the API is used over the Internet.
It is not recommended to invoke the API directly from browser using Javascript as this would require the "API Key" and "Auth Code" to be present on the browser side. Instead the API should be invoked from the web application server.
The resources and operations provided by the API will change over time as new features are added or existing features are modified. In order to maintain compatibility between the API clients and server each version of the API has a designated a version string. This string has to be specified as part of all the requests sent to the server. See Resource URIs for details on how to send the version number.
The URIs used by the API have a common base URI followed by the response data format and finally followed by the resource or collection URI.
The base URI is composed of the following parts
For example: https://apitest.happyfox.com/api/1.1/json/
The API server limits the number of requests that can be sent during a interval of time. There are independent limits for read and write operations. Contact the Helpdesk Admin to know the current limits and for changing them to meet requirements.
In case the request limits are exceeded the API server returns HTTP response code 503 along with the time to wait before retrying in the response body.
