HappyFox

App · 20 actions

Manage HappyFox tickets and contacts, add staff updates and notes, assign categories and agents, and watch tickets and contacts.

Actions

ActionWhat it does
Add private noteAdd private note.
Add staff updateAdd staff update.
Create contactCreate a contact.
Create ticketCreate ticket.
Delete contactDelete contact.
Delete ticketDelete ticket.
Get contactGet contact.
Get ticketGet ticket.
List agentsList agents.
List categoriesList categories.
List contact custom fieldsList contact custom fields.
List contactsList contacts.
List prioritiesList priorities.
List statusesList statuses.
List ticket custom fieldsList ticket custom fields.
List ticketsList tickets.
Move ticketMove ticket.
Subscribe agentSubscribe agent.
Unsubscribe agentUnsubscribe agent.
Update ticket tagsUpdate ticket tags.

Add private note

Add private note.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
StaffstaffnumberRequired
Staff.
TexttexttextRequired
Text.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Add staff update

Add staff update.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
StaffstaffnumberRequired
Staff.
TexttexttextRequired
Text.
Statusstatusnumber
Status.
Priorityprioritynumber
Priority.
Assigneeassigneenumber
Assignee.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Create contact

Create a contact. Accounts with mandatory contact custom fields require those fields to be configured first.

Inputs

NamenametextRequired
Name.
EmailemailtextRequired
Email.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 10
  }
}

Create ticket

Create ticket.

Inputs

NamenametextRequired
Name.
EmailemailtextRequired
Email.
SubjectsubjecttextRequired
Subject.
TexttexttextRequired
Text.
CategorycategorynumberRequired
Category.
Priorityprioritynumber
Priority.
Assigneeassigneenumber
Assignee.
Tagstagstext
Tags.
Visible only staffvisible_only_stafftrue/false
Visible only staff.
Due datedue_datedate
Due date.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "display_id": 100,
    "id": 100
  }
}

Delete contact

Delete contact.

Inputs

Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Delete ticket

Delete ticket.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
Agentstaff_idnumberRequired
Staff.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get contact

Get contact.

Inputs

Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "email": "qa@example.com",
    "id": 10,
    "name": "QA contact"
  }
}

Get ticket

Get ticket.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "display_id": 100,
    "id": 100,
    "subject": "QA ticket"
  }
}

List agents

List agents.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List categories

List categories.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List contact custom fields

List contact custom fields.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List contacts

List contacts.

Inputs

Pagepagenumber
Page.At least 1.
Sizesizenumber
Size.From 1 to 50.
Qqtext
Q.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": [],
    "page_info": {
      "count": 0
    }
  }
}

List priorities

List priorities.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List statuses

List statuses.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List ticket custom fields

List ticket custom fields.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List tickets

List tickets.

Inputs

Pagepagenumber
Page.At least 1.
Sizesizenumber
Size.From 1 to 50.
Statusstatustext
Status.
Categorycategorynumber
Category.
Qqtext
Q.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": [],
    "page_info": {
      "count": 0
    }
  }
}

Move ticket

Move ticket.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
Agentstaff_idnumberRequired
Staff.
Target categorytarget_category_idnumberRequired
Category.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Subscribe agent

Subscribe agent.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
Agentstaff_idnumberRequired
Staff.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Unsubscribe agent

Unsubscribe agent.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
Agentstaff_idnumberRequired
Staff.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update ticket tags

Update ticket tags.

Inputs

Ticket numberticket_numbertextRequired
Ticket number.
Agentstaff_idnumberRequired
Staff.
Addaddtext
Add.
Removeremovetext
Remove.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

On this page