Ticqex
Extending Ticqex

API & extension points

The REST API, MCP server, and workspace packages for building on Ticqex.

REST API

Everything the UI can do is available at /api/v1/*, authenticated with Authorization: Bearer <api-key> — tickets, board moves, messages and drafts, comments, contacts, statuses, tags, custom fields, settings, email snippets, and users.

The full surface is described by the OpenAPI spec in the repo at docs/openapi.yaml:

  • pnpm openapi:generate — regenerate the spec
  • pnpm openapi:check — verify it matches the routes

MCP server

The MCP endpoint at /api/mcp exposes tools mirroring the REST mutations. Parity between the two is enforced by a test suite, so anything you can automate over HTTP you can also do from an MCP-connected agent. See Connect an agent.

Workspace packages

The repo ships @ticqex/* packages (API client, API spec, CLI) under packages/ — build them with pnpm build:packages and test with pnpm test:packages.

Building integrations without forking

If you just need to get tickets in or out — a web form, a Slack workflow, a Zapier-style automation — you usually don't need a new channel at all: create tickets via the REST API (origin api). Build a full channel only when you need threaded two-way conversations with channel-specific behavior — see Adding a channel.

On this page