Knowledge Base

Read all Sections

URL <base_uri> / <response_format> /kb/sections
HTTP Method GET
Response Data List of sections

Data Structure

JSON

                    
    [
        {
            "id": 103,
            "articles": [
                {
                    "attachments": [],
                    "language": {
                        "visible": true,
                        "enabled": true,
                        "name": "english",
                        "id": 1
                    },
                    "views": 2,
                    "last_updated_at": "2013-05-25 11:22:11",
                    "full_url": "https://acmewidgetsco.happyfox.com/kb/article/16/",
                    "tags": [],
                    "related_articles": [],
                    "id": 16,
                    "title": "Email Forwarding Setup with Exchange 2007",
                    "slug": "email-forwarding-setup-with-exchange-2007",
                    "contents": "

dsaf

", "section_name": "Troubleshooting" }, { "attachments": [ { "url": "https://hf-files.s3.amazonaws.com/hdpacmewidgetsco_kb_attachments/2013/11-22/236592df-4b46-42e4-92be-56c749eb531a/stdet_update_via_mail.py", "filename": "stdet_update_via_mail.py" }, { "url": "https://hf-files.s3.amazonaws.com/hdpacmewidgetsco_kb_attachments/2013/11-22/3479e65c-4163-48a8-bfa2-5849dcbe97f3/daisy_create_ticket_through_email.py", "filename": "daisy_create_ticket_through_email.py" } ], "language": { "visible": true, "enabled": true, "name": "english", "id": 1 }, "views": 2, "last_updated_at": "2013-11-22 10:55:06", "full_url": "https://acmewidgetsco.happyfox.com/kb/article/38/", "tags": [], "related_articles": [], "id": 38, "title": "sample article", "slug": "sample-article", "contents": "

\r\n

Integrations

\r\n
    \r\n
  • Zapier Integration – Create zaps and integrate with other applications when a ticket is created on HappyFox
  • \r\n
  • Magento Integration – Get all your eCommerce information from Magento on your HappyFox ticket
  • \r\n
\r\n

New Features

\r\n
    \r\n
  • Forum on your Support Center – Get closer with your customers. Discuss ideas, issues and resolve them.
  • \r\n
  • Support for adding inline images in replies and private notes in tickets. Have your images embedded in messages!
  • \r\n
  • Announcement bar – Announce updates and news to your customers with the announcement bar on your Support center
  • \r\n
", "section_name": "Troubleshooting" } ], "name": "Troubleshooting", "categories": [], "description": "" } ]

Read One Section

URL <base_uri> / <response_format> /kb / section / <id>
HTTP Method GET
Response Data Section

Data Structure

JSON

                    
    {
        "articles": [
            {
                "attachments": [
                    {
                        "filename": "stdet_update_via_mail.py",
                        "url": "https://hf-files.s3.amazonaws.com/hdpacmewidgetsco_kb_attachments/2013/11-22/236592df-4b46-42e4-92be-56c749eb531a/stdet_update_via_mail.py"
                    },
                    {
                        "filename": "daisy_create_ticket_through_email.py",
                        "url": "https://hf-files.s3.amazonaws.com/hdpacmewidgetsco_kb_attachments/2013/11-22/3479e65c-4163-48a8-bfa2-5849dcbe97f3/daisy_create_ticket_through_email.py"
                    }
                ],
                "contents": "

\r\n

Integrations

\r\n
    \r\n
  • Zapier Integration – Create zaps and integrate with other applications when a ticket is created on HappyFox
  • \r\n
  • Magento Integration – Get all your eCommerce information from Magento on your HappyFox ticket
  • \r\n
\r\n

New Features

\r\n
    \r\n
  • Forum on your Support Center – Get closer with your customers. Discuss ideas, issues and resolve them.
  • \r\n
  • Support for adding inline images in replies and private notes in tickets. Have your images embedded in messages!
  • \r\n
  • Announcement bar – Announce updates and news to your customers with the announcement bar on your Support center
  • \r\n
", "full_url": "https://acmewidgetsco.happyfox.com/kb/article/38/", "id": 38, "language": { "enabled": true, "id": 1, "name": "english", "visible": true }, "last_updated_at": "2013-11-22 10:55:06", "related_articles": [], "section_name": "Troubleshooting", "slug": "sample-article", "tags": [], "title": "sample article", "views": 2 }, { "attachments": [], "contents": "

can add, edit and delete priorities and statuses which can be used application wide. Extremely simply process to customize the helpdesk as per your need.

", "full_url": "https://acmewidgetsco.happyfox.com/kb/article/8/", "id": 8, "language": { "enabled": true, "id": 1, "name": "english", "visible": true }, "last_updated_at": "2013-05-25 11:24:15", "related_articles": [], "section_name": "Troubleshooting", "slug": "integration-using-happyfox-api", "tags": [], "title": "Integration using HappyFox API", "views": 0 } ], "categories": [], "description": "", "id": 103, "name": "Troubleshooting" }

Read all Articles

URL <base_uri> / <response_format> /kb /articles
HTTP Method GET
Response Data List of external articles

Data Structure

JSON

                    
    [
        {
            "attachments": [],
            "language": {
                "visible": true,
                "enabled": true,
                "name": "english",
                "id": 1
            },
            "views": 30,
            "last_updated_at": "2014-05-22 02:30:09",
            "full_url": "https://acmewidgetsco.happyfox.com/kb/article/1/",
            "tags": [],
            "related_articles": [],
            "id": 1,
            "title": "Real Estate Financing",
            "slug": "real-estate-financing",
            "contents": "

A Smart Rule can be defined having the Due Date of tickets as either a condition and/or an action.

\r\n

\r\n

To set the Due Date as a condition, select “Due Date” in the drop down list of “Conditions for this rule”. The Due Date, as a condition, allows to find tickets that are either “Due Today”, “Due in (Is in) ” a specified number of days or “Overdue by (Gone past by)” a specified number of days.

\r\n

\r\n

The Due Date, as an action, allows to set the “Due Date” of the tickets matching the conditions specified in a specified number of days. To set the due date to the current day, you can use Set Due Date in 0 days as the action.

\r\n

", "section_name": "Help" }, { "attachments": [], "language": { "visible": true, "enabled": true, "name": "english", "id": 1 }, "views": 16, "last_updated_at": "2013-12-23 15:01:26", "full_url": "https://acmewidgetsco.happyfox.com/kb/article/2/", "tags": [], "related_articles": [], "id": 2, "title": "Foreclosures", "slug": "foreclosures", "contents": "

A Smart Rule can be defined having the Due Date of tickets as either a condition and/or an action.

\r\n

\r\n

To set the Due Date as a condition, select “Due Date” in the drop down list of “Conditions for this rule”. The Due Date, as a condition, allows to find tickets that are either “Due Today”, “Due in (Is in) ” a specified number of days or “Overdue by (Gone past by)” a specified number of days.

\r\n

\r\n

The Due Date, as an action, allows to set the “Due Date” of the tickets matching the conditions specified in a specified number of days. To set the due date to the current day, you can use Set Due Date in 0 days as the action.

\r\n

", "section_name": "Getting Started" } ]

Read One Article

URL <base_uri> / <response_format> /kb / article / <id>
HTTP Method GET
Response Data Article (if its external)

Data Structure

JSON

                    
    {
        "attachments": [],
        "language": {
            "visible": true,
            "enabled": true,
            "name": "english",
            "id": 1
        },
        "views": 30,
        "last_updated_at": "2014-05-22 02:30:09",
        "full_url": "https://acmewidgetsco.happyfox.com/kb/article/1/",
        "tags": [],
        "related_articles": [],
        "id": 1,
        "title": "Real Estate Financing",
        "slug": "real-estate-financing",
        "contents": "

A Smart Rule can be defined having the Due Date of tickets as either a condition and/or an action.

\r\n

\r\n

To set the Due Date as a condition, select “Due Date” in the drop down list of “Conditions for this rule”. The Due Date, as a condition, allows to find tickets that are either “Due Today”, “Due in (Is in) ” a specified number of days or “Overdue by (Gone past by)” a specified number of days.

\r\n

\r\n

The Due Date, as an action, allows to set the “Due Date” of the tickets matching the conditions specified in a specified number of days. To set the due date to the current day, you can use Set Due Date in 0 days as the action.

\r\n

", "section_name": "Help" }

Search Articles

URL <base_uri> / <response_format> / kb / search / ?q=<search text>
HTTP Method GET
Response Data Articles as search results. The search happens on titles of the knowledge base articles.

Data Structure

JSON

                    
    [
        {
            "last_updated_at": "2013-02-19 17:18:02", 
            "public_url": "/kb/article/1", 
            "views": 3, 
            "id": 1, 
            "title": "Can you please help me solve my problem?"
        }
    ]