APIs

The Ziqme API

REST, webhooks, and real-time events — everything routes through one gateway.

REST APIs

Versioned REST endpoints for tickets, chats, customers, articles, and workflows — behind one gateway at api.ziqme.com.

Webhooks

Subscribe to events like ticket.created or chat.started and receive signed deliveries to your endpoints.

Real-time events

SignalR hubs stream live tickets, chats, and dashboard updates straight into your own apps.

Authentication

Authenticate with OAuth2 client credentials or a user JWT. Every request carries your workspace context, so you only ever see your own data.

Rate limits

Fair-use rate limits are applied per workspace at the gateway. Responses include standard headers so your integration can back off gracefully.

Versioning

APIs are versioned in the URL (v1 today). Breaking changes ship as a new version — existing integrations keep working.

Example request

curl https://api.ziqme.com/api/v1/tickets \
  -H "Authorization: Bearer $ZIQME_ACCESS_TOKEN"

HTTP/1.1 200 OK
{
  "items": [
    {
      "id": "7d9f1c2e-4b6a-4f3d-9c1e-2a8b5d0e7f41",
      "subject": "Order #1042 arrived damaged",
      "status": "open",
      "priority": "high"
    }
  ],
  "totalCount": 128
}