-
Notifications
You must be signed in to change notification settings - Fork 44
Add HappyFox skill for help desk ticket management #197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jpshackelford
wants to merge
7
commits into
main
Choose a base branch
from
add-happyfox-skill
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+720
−0
Open
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
95e0bcc
Add HappyFox skill for help desk ticket management
openhands-agent 37eb7d7
Support both HFOX and HAPPYFOX environment variable prefixes
openhands-agent 17d6ebf
docs(happyfox): clarify private notes vs staff updates and add API be…
openhands-agent a9e6551
happyfox: document write-safety, dead-end endpoints, HTML-only rendering
openhands-agent 597e227
happyfox: document t-cf-<id> custom-field convention on POST /tickets/
openhands-agent 0f192a0
happyfox: document 'Attaching Files to Updates' section
openhands-agent 9a700bd
happyfox: document custom-field updates via /staff_update/ and the no…
openhands-agent File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # HappyFox | ||
|
|
||
| Interact with HappyFox help desk - create tickets, add updates, manage ticket status, and query tickets using the HappyFox REST API. Use when working with HappyFox support tickets or help desk operations. | ||
|
|
||
| ## Triggers | ||
|
|
||
| This skill is activated by the following keywords: | ||
|
|
||
| - `happyfox` | ||
| - `help desk` | ||
| - `support ticket` | ||
|
|
||
| ## Details | ||
|
|
||
| The skill supports two environment variable prefixes. Use whichever matches your configuration: | ||
|
|
||
| ### Option 1: HFOX Prefix (supports custom domains) | ||
| - `HFOX_API_KEY`: Your HappyFox API key | ||
| - `HFOX_AUTH_CODE`: Your HappyFox auth code | ||
| - `HFOX_BASE_URL`: Full base URL (e.g., `https://support.example.com` or `https://acme.happyfox.com`) | ||
|
|
||
| ### Option 2: HAPPYFOX Prefix (standard HappyFox domains) | ||
| - `HAPPYFOX_API_KEY`: Your HappyFox API key | ||
| - `HAPPYFOX_AUTH_CODE`: Your HappyFox auth code | ||
| - `HAPPYFOX_SUBDOMAIN`: Your HappyFox subdomain (e.g., `acme` for `acme.happyfox.com`) | ||
|
|
||
| <IMPORTANT> | ||
| You can use `curl` with basic authentication to interact with HappyFox's REST API. | ||
| ALWAYS use the HappyFox API for operations instead of a web browser. | ||
| Before performing any HappyFox operations, run the credential detection script to set up the unified `$HF_*` variables. | ||
| </IMPORTANT> | ||
|
|
||
| ## Features | ||
|
|
||
| - **Create Tickets**: Create new support tickets with contacts, categories, and custom fields | ||
| - **Update Tickets**: Add staff replies, change status, priority, assignee, and tags | ||
| - **Private Notes**: Add internal notes visible only to staff | ||
| - **Query Tickets**: List, filter, and search tickets by various criteria | ||
| - **Manage Categories**: Move tickets between categories | ||
| - **Custom Fields**: Support for ticket and contact custom fields | ||
|
|
||
| ## Important Concepts | ||
|
|
||
| ### Authentication | ||
|
|
||
| HappyFox uses HTTP Basic Authentication where: | ||
| - Username = API Key | ||
| - Password = Auth Code | ||
|
|
||
| ### Ticket Identifiers | ||
|
|
||
| - **Ticket Number**: The numeric ID used in API endpoints (e.g., `3`) | ||
| - **Display ID**: Human-readable ID shown in the UI (e.g., `#DC00000003`) | ||
|
|
||
| ### Status Behaviors | ||
|
|
||
| | Behavior | Description | | ||
| |----------|-------------| | ||
| | `pending` | Ticket is open and active | | ||
| | `completed` | Ticket is closed/resolved | | ||
|
|
||
| ### Custom Field Format | ||
|
|
||
| Custom fields use a specific format in API payloads: | ||
| - Ticket custom fields: `t-cf-<ID>` | ||
| - Contact custom fields: `c-cf-<ID>` | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [HappyFox API Overview](https://support.happyfox.com/kb/article/360-api-for-happyfox/) | ||
| - [Tickets API Endpoints](https://support.happyfox.com/kb/article/1039-tickets-endpoint/) | ||
| - [Creating API Credentials](https://support.happyfox.com/kb/article/476-create-api-key-auth-code-happyfox/) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is my first time reviewing these repo. Is it in fact that case that this skill directory gets pulled into every agent conversation on our SaaS / OHE instances by default? If so I think "help desk" and "support ticket" are too broad of triggers. Other customers may have help desk flows and be using Zendesk or Intencom and not HappyFox.