HappyFox provides you with RESTful APIs where you can create a ticket, add updates to a ticket, list tickets and users and much more. JSON, Form Urlencoded and Multipart Form Data are the supported formats for the APIs.
What you need, how you can use it, API version, Resource URI and all other information can be found here on this exclusive page for APIs
- How to create API auth code and key
- Tickets endpoint
- Contacts and contact groups endpoint
- Reports endpoint
- Set multiple option custom fields using API
- Asset management via API
- Export Knowledge Base
- API Rate limting
If your HappyFox account is hosted in EU, please use <account_name>.happyfox.net
Other commonly used endpoints are listed below.
API key and auth code are to be passed in Basic HTTP authentication format only.
1. List categories
API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/categories/
2. List staffs/agents
API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/staff/
3. List all statuses
API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/statuses/
4. List metadata of all ticket custom fields
API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/ticket_custom_fields/
5. List metadata of all contact custom fields
API Endpoint: https://<account_name>
HTTP Method: GET
External articles - https://<account_name>.happyfox.com/api/1.1/json/kb/articles/
Internal articles - https://<account_name>.happyfox.com/api/1.1/json/kb/internal-articles/
All sections - https://<account_name>.happyfox.com/api/1.1/json/kb/sections/
Export single article - https://<account_name>.happyfox.com/api/1.1/json/kb/article/<id_of_the_article>
Export single section - https://<account_name>.happyfox.com/api/1.1/json/kb/section/<id_of_the_section>
The above url allows you to access one article a time, using the article id provided from the /articles/ endpoint in the previous step. This is applicable only for external articles.