Product · Free download

HESK API

A REST API and staff token portal that sits beside your existing HESK 3.7 help desk. Automations talk to the API. Staff keep using HESK. The help-desk PHP is not patched.

Download v1.4.0 Install Features

SHA-256 3e7a0e47082150e67605985be3e53e0303690eba54829c6d37571211933c6cfe · checksum file

Tickets, replies, files

List, create, update, and close tickets by id or tracking id. Staff replies, internal notes (with files), related-ticket links, and attachments.

Tokens are staff accounts

Sign in at the API host with a HESK staff username and password. Each token inherits that user’s categories, privileges, and admin flag.

Your branding, your host

Local config overlays paths, CORS, rate limits, token prefix, and the vendor name shown in the portal and live OpenAPI spec.

Quick start

unzip hesk-api-1.4.0.zip
cd hesk-api-1.4.0
php bin/install.php \
  --hesk-path=/var/www/hesk \
  --api-url=https://api.help.example.com \
  --create-token --user=admin --name=Bootstrap

Point a TLS vhost at public/. Then GET /health should return status: ok and version: 1.4.0.

What you get

OpenAPI 3.0 for tickets, notes (including note attachments), links, attachments, customers, categories, users, knowledgebase, and canned replies
Staff portal: /login, /tokens, Swagger UI at /docs
Live /openapi.json rewritten for this install’s public URL
Optional customer/staff email via HESK’s own templates (notify: true|false)
Two extra tables only: {prefix}api_tokens and {prefix}api_audit_log

It is not a replacement help-desk UI. Customer portal users cannot mint API tokens.

Requirements

HESK 3.7.x (developed against 3.7.11)
PHP 8.1+ with pdo_mysql, json, mbstring, openssl
The same MySQL database HESK already uses
A hostname and TLS certificate for the API (a second vhost is the usual layout)

Full install and customization →