AI agents and coding assistants

Everything on this site is published for machines as well as people. Point your coding agent at it once and it can look up the exact request shapes, error codes and limits while it writes your integration.

You want the agent to	Use
Set up and run your Tawked account with you	The quickstart: the Tawked MCP server and the Account API
Look things up in these docs while it codes	The docs MCP server
Know Tawked’s rules before it starts	The skill
Read one page, or the whole site at once	Markdown pages, `llms.txt`, `llms-full.txt`
Generate a client or read the exact schemas	The OpenAPI document
Follow API changes	The changelog and its RSS feed

Work in your account

Two servers carry the name MCP, and they do different things. The Tawked MCP server at https://tawked.com/mcp works in your account: an assistant signs in (Claude, ChatGPT, Cursor, Codex, Claude Code), or holds an account token you made (Claude Code, scripts), and does what you do in the console, as you and never more. It creates and checks WhatsApp templates, adds members and support team members, adds e-mail domains and checks their DNS, and the rest. It waits for your yes before anything that sends, spends or deletes, and when a step is yours (connecting a WhatsApp number in Meta’s window, paying by card) it tells you what to do and gives you the link. See Tawked MCP server. Under it is the Account API, for an agent or a script that calls HTTP itself: an account token from Settings → Account API, GET /v1/me first, then GET /v1/operations?q=… to find the operation for the job. The quickstart has the steps for each assistant and the prompt to give it; The person in the loop and Security say what your agent may do alone and what waits for you.

claude mcp add --transport http tawked https://tawked.com/mcp --header "Authorization: Bearer tk_acct_…"

The docs MCP server below only reads this documentation. Both are named tawked in the examples: to keep both in one assistant, name one of them tawked-docs.

Connect the docs MCP server

The site hosts a Model Context Protocol server at https://docs.tawked.com/mcp. It gives an agent three tools: search the docs, read any page or section, and report a problem back to us. No key, no account. It reads the documentation only: it cannot see or change anything on your Tawked account.

claude mcp add --transport http tawked https://docs.tawked.com/mcp

Add to ~/.codex/config.toml:

[mcp_servers.tawked]
type = "http"
url = "https://docs.tawked.com/mcp"

Add to .cursor/mcp.json in your project, or the global mcp.json:

{
  "mcpServers": {
    "tawked": { "url": "https://docs.tawked.com/mcp" }
  }
}

Add to .vscode/mcp.json:

{
  "servers": {
    "tawked": { "type": "http", "url": "https://docs.tawked.com/mcp" }
  }
}

Add to mcp_config.json:

{
  "mcpServers": {
    "tawked": { "serverUrl": "https://docs.tawked.com/mcp" }
  }
}

Add to opencode.json:

{
  "mcp": {
    "tawked": { "type": "remote", "url": "https://docs.tawked.com/mcp", "enabled": true }
  }
}

Settings, then Connectors, Add custom connector, URL https://docs.tawked.com/mcp.

The same options sit behind the menu at the top of every page: copy the page as Markdown, open it in ChatGPT or Claude, add the MCP server to Cursor or VS Code in one click, or download the OpenAPI document from any reference page.

Install the skill

Agents that support skills can load a generated skill.md that describes what Tawked does and how the calls fit together:

npx skills add https://docs.tawked.com

The file is maintained with these pages and tested against the same source as the API reference, so it never goes stale. Read it directly at /skill.md.

Follow changes

The changelog lists every change to the API, its webhooks and its integrations, dated by the day it reached production, with breaking changes tagged. Subscribe to its feed at /changelog/rss.xml, or point an agent at it before it upgrades your integration.

Read pages as Markdown

Every page is available as clean Markdown. Append .md to its URL, or ask for it with an Accept header:

curl -L -H "Accept: text/markdown" https://docs.tawked.com/quickstart

Two index files cover the whole site: llms.txt lists every page with a description, and llms-full.txt is the whole site in one file for a context window.

The OpenAPI document

The API reference on this site is generated from https://tawked.com/openapi.json, an OpenAPI 3.1 document with every endpoint, parameter, response example and error code. Feed it to a code generator, a request client, or an agent that reads specs directly. Tawked also publishes an RFC 9727 API catalog at the well-known path.

A prompt that works

Paste one of these into your agent along with the docs MCP server or the llms-full.txt file. Each quickstart (Verify, Notifications, Partners) carries its own at the top, and so does Conversation menus for a page beside Tawked Chat’s conversations. For Tawked Verify:

Integrate Tawked Verify (one-time codes by SMS) into this project.
Use the Tawked docs (MCP server or llms-full.txt) for every request shape and error code; do not guess.
Rules from the docs: authenticate with a Bearer key from an environment variable, never in code.
Call POST /v1/verify/start with `to`, `lang` and a `reference`, and send an Idempotency-Key per attempt.
Call POST /v1/verify/check with the id and the code the user typed; branch on `verified`, then on `status`.
Match errors on the `error` string, never on the HTTP status alone.
Use a tk_test_ key until the application is approved.

For Tawked Notifications:

Send WhatsApp notifications from this project with Tawked Notifications.
Use the Tawked docs (MCP server or llms-full.txt), starting at /whatsapp/overview, for every request shape and error code; do not guess.
Authenticate with the application's tk_live_ key from an environment variable, never in code; there is no WhatsApp sandbox.
Call GET /v1/whatsapp/templates to read each template's placeholders, then POST /v1/whatsapp/messages with `to`, `template`, `lang`, `params` and a `reference`, and an Idempotency-Key per business event.
Treat the 202 as accepted, not delivered: read the status with GET /v1/whatsapp/messages/{id} or from the message.* webhooks, verifying tawked-signature over the raw body.
Match errors on the `error` string, never on the HTTP status alone.

For a platform integrating as a partner:

Integrate Tawked as a partner platform into this project.
Use the Tawked docs (MCP server or llms-full.txt), starting at /partners/overview, for every request shape and error code; do not guess.
Authenticate with the tk_partner_ key from an environment variable, never in code.
On merchant install, call POST /v1/partner/applications with our own merchant id as `external_id`, the two brand names and the website; treat 200 and 201 alike and store nothing but the external_id.
Pass `application` with that id on every /v1/verify call (in the body on POST, as ?application= on GET), and an Idempotency-Key per attempt.
Receive the partner webhooks at one endpoint, verify tawked-signature over the raw body, and update the merchant state from service.approved, service.rejected, service.suspended and service.paused.
Match errors on the `error` string, never on the HTTP status alone.

For a platform whose merchants each connect their own application:

Build a Tawked integration into this platform, where each merchant connects their own Tawked application.
Use the Tawked docs (MCP server or llms-full.txt), starting at /integrations/build-your-own, for every request shape and error code; do not guess.
Store each merchant's tk_live_ key (and, during review, tk_test_ key) encrypted on our server; never print it back in full and never send it to a browser.
Ask for keys with custom access: verify:send for codes, notifications:send for WhatsApp messages, nothing more.
Add a "Test connection" button: POST /v1/verify/00000000-0000-0000-0000-000000000000/resend with {} and map 404 not_found, 403 account_not_active, 403 insufficient_scope and 401 to a sentence for the merchant.
Send an Idempotency-Key per business event, retry only send_failed, templates_unavailable, too_many_requests and timeouts with the same key, and normalise numbers to +9665 before calling.

Agents connected to the docs MCP server read the docs only. They cannot send messages or spend credits: that takes your API key in your own code, or the Tawked MCP server with your yes.

Get started

Verify

Notifications

Email

Webhooks and errors

Partners

Build with AI

AI agents and coding assistants

Work in your account

Connect the docs MCP server

Install the skill

Follow changes

Read pages as Markdown

The OpenAPI document

A prompt that works

​Work in your account

​Connect the docs MCP server

​Install the skill

​Follow changes

​Read pages as Markdown

​The OpenAPI document

​A prompt that works

Work in your account

Connect the docs MCP server

Install the skill

Follow changes

Read pages as Markdown

The OpenAPI document

A prompt that works