Karzoun Docs

Welcome to the Karzoun GraphQL API docs — guides, playground, and schema for partner app builders, integration engineers, and teams wiring AI agents that need live, permissioned access to workspace data. Sales, support, and marketing already share one Karzoun workspace. Your integration inherits that unity: one app token model, one permission story, one customer record across channels.

Looking for day-to-day product how-tos? Start from the docs home or Help Center — this section is for builders. If the GraphQL gateway is down for everyone, check Status.

Choose your path

Quickstart

First authenticated GraphQL call in minutes.

Authentication

Apps, tokens, and how requests are authorized.

GraphQL API

Schema reference — queries, mutations, and types.

Webhooks

React to conversation, contact, and app events.

MCP

Tool access for Cursor, Claude, and agents.

MiniApps

JSON Marketplace apps — build locally, submit for review.

When to use what

Need	Prefer	Why
Read/write data on demand	GraphQL	Full schema, playground, precise queries
React when something happens	Webhooks	Push events to your server with signatures
AI client needs tools	MCP	Permissioned tools over the same workspace data
Embed UI in the inbox	Dashboard SDK	iframe apps calling `executeAction` (host → `executeMiniAppAction`)
Ship a reusable connector	MiniApps	Marketplace JSON definition + review

Security checklist

Store app tokens on the server — never in client JavaScript or public repos
Verify webhook signatures (x-karzoun-signature-256) before trusting payloads
Scope each app to the least privileges your integration needs
Rotate tokens when people leave or integrations are retired

Try it

curl -X POST 'https://YOUR_SUBDOMAIN.api.karzoun.chat/graphql' \
  -H 'Content-Type: application/json' \
  -H 'x-app-token: YOUR_APP_TOKEN' \
  -d '{"query":"query { tags(page: 1, perPage: 3) { data { name } } }"}'

Prefer a visual editor? Open the GraphQL Playground.

What your integration can touch

Area	Examples
Shared inbox	Omnichannel conversations — WhatsApp, email, webchat, Messenger, Instagram
CRM & segments	Customers, companies, tags, custom fields, dynamic segments
Automations	Triggers, conditions, and actions across inbox and channels
AI	Copilot and agents grounded in CRM and conversation context
Marketing	Broadcasts, templates, and campaign analytics
Operations	Tasks, orders, meetings, files, team chat

Field-level docs live in the GraphQL reference. Non-technical product guides live in the Help Center.

Last modified on August 12, 2026

Getting started

Guides

Try it

Overview

Choose your path

Quickstart

Authentication

GraphQL API

Webhooks

MCP

MiniApps

When to use what

Security checklist

Try it

What your integration can touch

​Choose your path

Quickstart

Authentication

GraphQL API

Webhooks

MCP

MiniApps

​When to use what

​Security checklist

​Try it

​What your integration can touch

Choose your path

When to use what

Security checklist

Try it

What your integration can touch