HappyFox API

12 endpoints for HappyFox, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/happyfox
Connects with: Your own HappyFox staff login on your account URL (agent or admin). What your agent can do follows your role. You sign in in your own browser and keep your SSO or 2-step verification.
Integration page: HappyFox

Read (8)

Return data and change nothing in the account.

HappyFox Endpoints: Read
Endpoint	Description
GET /tickets/search	Tickets in a queue or matching a text search, with status, priority, category and assignee.
GET /tickets/{ticket_id}	One ticket with its fields, tags and every update, staff replies, contact messages and private notes.
GET /queues	Ticket queues you can open: the ready-made ones and the ones your team set up.
GET /categories	Ticket categories with ID and name.
GET /statuses	Ticket statuses with ID, name and behaviour, pending or completed.
GET /priorities	Ticket priorities with ID and name.
GET /agents	Agents who can be assigned tickets, with ID, name and role.
GET /canned-actions	Canned actions with ID, name and the categories they are defined for.

Change the account. Calls marked Confirm wait for the user to approve them.

HappyFox Endpoints: Write
Endpoint	Description
POST /tickets/{ticket_id}/replies Confirm	Send a reply to the contact and optionally set the status in the same call.
POST /tickets/{ticket_id}/private-notes Confirm	Add a note only your team can see, and optionally alert subscribers or agents.
PATCH /tickets/{ticket_id} Confirm	Change status, priority, assignee or tags of one ticket.
POST /tickets/{ticket_id}/canned-actions/{canned_action_id}/apply Confirm	Apply a canned action to a ticket as a reply or a private note and submit it.