ARN Smart Support
Language: English

Open tickets from your own applications (ticket API)

Updated 9 Nov 2026 3 min read
Browse Ticketix articles

Your own applications, for example a plugin, a desktop app or a website, can open tickets for their users and send technical details with them, such as the version of the application or the server. Each application gets its own key. Revoke a key, and that application stops at once.

Where to find it: Setup → Support → Application keys (administrators only).

Create an application key

  1. Open Setup → Support → Application keys.
  2. Enter the name of the Application, for example WordPress plugin. Staff see this name as the channel of the tickets it opens.
  3. Choose the Product when the request names none, or Request must name the product.
  4. Click Create key.
  5. Copy the key now and keep it in the settings of the application. It is shown only this once; Ticketix stores only a hash of it.

The list shows each application with the start of its key, its product, the number of its tickets, when it was Last used and when it was created. Revoke stops a key at once; tickets that the application opened keep its name.

Open a ticket

Send a POST request with a JSON body to /api/ticket-create.php under the address of your installation, for example https://support.example.com/api/ticket-create.php. Send the key in the Authorization: Bearer header, or in X-Ticketix-Key where your server drops the Authorization header.

POST /api/ticket-create.php
Authorization: Bearer tkx_…
Content-Type: application/json

{
  "email": "customer@example.com",
  "name": "Customer Name",
  "product": "helpdesk",
  "subject": "Licence shows Inactive after moving the site",
  "message": "We moved the site to a new domain …",
  "priority": "normal",
  "technical_details": {
    "WordPress": "6.8",
    "PHP": "8.3",
    "Plugin version": "2.0.2"
  }
}
FieldRequiredMeaning
emailYesThe customer's email address; a new customer is created for an unknown address
nameNoThe customer's name, up to 120 characters
productNoA product key; without it, the product of the key is used
subjectYesUp to 200 characters
messageYesPlain text, up to 20,000 characters
priorityNolow, normal (default) or high
technical_detailsNoUp to 30 names and values; a name up to 60 and a value up to 500 characters; values are text, numbers or true and false

The request body can be up to 64 KB.

What happens with the ticket

  • The ticket is open at once; the key vouches for the request, so there is no email verification.
  • The customer receives the usual Ticket created email with the ticket link, and staff receive the usual notifications.
  • Routing rules, workflows, SLA policies and AI triage run as for any new ticket.
  • The ticket screen shows the name of the application as the channel, "with technical details", and the technical details under the first message ("Sent by" and the application name). The customer sees the same details on their ticket.

Answers

StatusMeaning
201The ticket was opened; the answer contains ticket_no and status
401The key is missing, wrong or revoked
405The request was not a POST
413The body is larger than 64 KB
415The body is not JSON (Content-Type: application/json)
422A field is wrong; fields names each field with the reason
429Too many tickets: 60 an hour per application and 10 an hour per customer

On Nginx, the server must run PHP in the api folder; see Ticketix server requirements.

On this page

Submit a ticket

Create a new support request without needing a portal account.

Priority
Attachments
Only you and our staff see a ticket. Never send passwords or licence codes.

Track a ticket

Use the ticket number and password from your confirmation email.

The number and the password are in your confirmation email.

Sign in

Access your support portal account.

New here?

Create account

Create your support portal account.

Already have an account?

Forgot password?

We email you a link to choose a new password.

Conversation

Was this helpful?
Open full article
↑ ↓ to moveEnter to openEsc to close