Overview
Help Desk 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, Analyze and Improve your Customer Support.
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
Custom fields allow additional data to be added to the Helpdesk as required. Custom fields can be defined for independently for users and tickets. For example, a phone number custom field can be added for users.
| URL | <base_uri> / <response_format> /user_custom_fields/ |
|---|---|
| HTTP Method | GET |
| Response Data | List of User Custom Field |
JSON
[
{
"name": "Company",
"depends_on_choice": null,
"required": false,
"id": 51,
"choices": null,
"type": "text",
"order": 2,
"visible_to_staff_only": true
},
{
"name": "Phone",
"depends_on_choice": null,
"required": false,
"id": 60,
"choices": null,
"type": "number",
"order": 3,
"visible_to_staff_only": true
},
{
"name": "Customer Type",
"depends_on_choice": null,
"required": false,
"id": 71,
"choices": [
{
"text": "Free",
"id": 44,
"dependant_fields": []
},
{
"text": "Paid",
"id": 43,
"dependant_fields": []
},
{
"text": "Premium",
"id": 42,
"dependant_fields": [
72
]
}
],
"type": "choice",
"order": 7,
"visible_to_staff_only": true
}
]
| URL | <base_uri> / <response_format> /user_custom_field/<id>/ |
|---|---|
| HTTP Method | GET |
| Response Data | User Custom Field |
JSON
{
"name": "Company",
"depends_on_choice": null,
"required": false,
"id": 1,
"choices": null,
"type": "text",
"order": 1,
"visible_to_staff_only": true
}
| URL | <base_uri> / <response_format> /ticket_custom_fields/ |
|---|---|
| HTTP Method | GET |
| Response Data | List of Ticket Custom Field |
JSON
[
{
"name": "Count",
"depends_on_choice": null,
"required": true,
"compulsory_on_completed": true,
"choices": null,
"type": "number",
"id": 55,
"categories": [
{
"category": 81,
"order": 1
}
],
"visible_to_staff_only": false
},
{
"name": "Example field",
"depends_on_choice": null,
"required": true,
"compulsory_on_completed": false,
"choices": null,
"type": "text",
"id": 69,
"categories": [
{
"category": 70,
"order": 10
},
{
"category": 72,
"order": 10
}
],
"visible_to_staff_only": true
},
{
"name": "sample",
"depends_on_choice": null,
"required": true,
"compulsory_on_completed": true,
"choices": null,
"type": "number",
"id": 104,
"categories": [],
"visible_to_staff_only": true
}
]
| URL | <base_uri> / <response_format> /ticket_custom_field/<id>/ |
|---|---|
| HTTP Method | GET |
| Response Data | Ticket Custom Field |
JSON
{
"name": "Notes",
"depends_on_choice": null,
"required": false,
"id": 76,
"choices": null,
"type": "text",
"order": 12,
"visible_to_staff_only": true
}
| URL | <base_uri> / <response_format> / ticket_custom_fields/ |
|---|---|
| HTTP Method | POST |
| Request Data | Create ticket custom field |
| Response Data | Ticket custom field |
{
"name": "Example Ticket Custom Field",
"type": "text",
"compulsory_on_completed": true,
"required": false,
"depends_on_choice": null,
"categories":[7,2,6]
}
{
"name": "Example Field",
"required": true,
"compulsory_on_completed": false,
"type": "dropdown",
"choices":["A","B"]
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": false,
"compulsory_on_completed": false,
"type": "number",
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": true,
"compulsory_on_completed": false,
"type": "multiple option",
"choices":["A","B","C"],
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": false,
"compulsory_on_completed": false,
"type": "date",
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": true,
"compulsory_on_completed": false,
"type": "multiple option",
"choices":["A","B","C"],
"categories": [1],
"visible_to_staff_only": true,
"depends_on":5,
"depends_on_value":6
}
Sample Response JSON
{
"name": "Example Ticket Custom Field",
"depends_on_choice": null,
"required": false,
"compulsory_on_completed": true,
"choices": null,
"type": "text",
"id": 36,
"categories": [
{
"category": 7,
"order": 1
},
{
"category": 2,
"order": 22
},
{
"category": 6,
"order": 3
}
],
"visible_to_staff_only": true
}
| URL | <base_uri> / <response_format> / user_custom_fields/ |
|---|---|
| HTTP Method | POST |
| Request Data | Create user custom field |
| Response Data | User custom field |
{
"name": "Example User Custom Field",
"type": "text",
"compulsory_on_completed": true,
"required": false,
"depends_on_choice": null
}
{
"name": "Example Field",
"required": true,
"compulsory_on_completed": false,
"type": "dropdown",
"choices":["A","B"]
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": false,
"compulsory_on_completed": false,
"type": "number",
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": true,
"compulsory_on_completed": false,
"type": "multiple option",
"choices":["A","B","C"],
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": false,
"compulsory_on_completed": false,
"type": "date",
"categories": [1],
"visible_to_staff_only": true
}
{
"name": "Example field",
"required": true,
"compulsory_on_completed": false,
"type": "multiple option",
"choices":["A","B","C"],
"categories": [1],
"visible_to_staff_only": true,
"depends_on":5,
"depends_on_value":6
}
Sample Response JSON
{
"name": "Example User Custom Field",
"depends_on_choice": null,
"required": false,
"choices": null,
"id": 49,
"type": "text",
"order": 31,
"visible_to_staff_only": true
}