# HappyFox

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/happyfox

## Actions

### Add private note

Add private note.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Staff (`staff`, number, required): Staff.
- Text (`text`, text, required): Text.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Add staff update

Add staff update.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Staff (`staff`, number, required): Staff.
- Text (`text`, text, required): Text.
- Status (`status`, number): Status.
- Priority (`priority`, number): Priority.
- Assignee (`assignee`, number): Assignee.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Create contact

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

**Inputs**

- Name (`name`, text, required): Name.
- Email (`email`, text, required): Email.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 10
  }
}
```

### Create ticket

Create ticket.

**Inputs**

- Name (`name`, text, required): Name.
- Email (`email`, text, required): Email.
- Subject (`subject`, text, required): Subject.
- Text (`text`, text, required): Text.
- Category (`category`, number, required): Category.
- Priority (`priority`, number): Priority.
- Assignee (`assignee`, number): Assignee.
- Tags (`tags`, text): Tags.
- Visible only staff (`visible_only_staff`, true/false): Visible only staff.
- Due date (`due_date`, date): Due date.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "display_id": 100,
    "id": 100
  }
}
```

### Delete contact

Delete contact.

**Inputs**

- Contact (`contact_id`, text, required): Contact ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Delete ticket

Delete ticket.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Agent (`staff_id`, number, required): Staff.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get contact

Get contact.

**Inputs**

- Contact (`contact_id`, text, required): Contact ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "email": "qa@example.com",
    "id": 10,
    "name": "QA contact"
  }
}
```

### Get ticket

Get ticket.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "display_id": 100,
    "id": 100,
    "subject": "QA ticket"
  }
}
```

### List agents

List agents.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List categories

List categories.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List contact custom fields

List contact custom fields.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List contacts

List contacts.

**Inputs**

- Page (`page`, number): Page. At least 1.
- Size (`size`, number): Size. From 1 to 50.
- Q (`q`, text): Q.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": [],
    "page_info": {
      "count": 0
    }
  }
}
```

### List priorities

List priorities.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List statuses

List statuses.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List ticket custom fields

List ticket custom fields.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List tickets

List tickets.

**Inputs**

- Page (`page`, number): Page. At least 1.
- Size (`size`, number): Size. From 1 to 50.
- Status (`status`, text): Status.
- Category (`category`, number): Category.
- Q (`q`, text): Q.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": [],
    "page_info": {
      "count": 0
    }
  }
}
```

### Move ticket

Move ticket.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Agent (`staff_id`, number, required): Staff.
- Target category (`target_category_id`, number, required): Category.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Subscribe agent

Subscribe agent.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Agent (`staff_id`, number, required): Staff.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Unsubscribe agent

Unsubscribe agent.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Agent (`staff_id`, number, required): Staff.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Update ticket tags

Update ticket tags.

**Inputs**

- Ticket number (`ticket_number`, text, required): Ticket number.
- Agent (`staff_id`, number, required): Staff.
- Add (`add`, text): Add.
- Remove (`remove`, text): Remove.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```
