Skip to main content

API and integrations

Ways for other systems to work with the desk.

  • API tokens and the REST API: tokens, scopes and limits. The endpoints are described at /api/docs on your desk, and as OpenAPI 3.1 at /api/v1/openapi.json.
  • Webhooks: case events posted to your systems as they happen, signed, with retries and a delivery log.
  • Form submissions: the public form endpoints, from a browser or signed from your backend.
  • The audit API: process controls, exceptions, populations, samples and evidence packs, the configuration, approvals on cases, and exports with their checksums.
  • MCP server: Claude, ChatGPT and other assistants working with cases, through OAuth or a token.
  • Building a plugin: the extension points (pages, routes, case panels and actions, timeline entries, inbox bulk actions, case events, permissions, MCP tools), the manifest, and the APIs of the plugins that come with the desk: Software Development, Service Configuration, Problem, Change, Incident and Major Incident Management, Status Page and Access Management.