# Blueticked API

> Blueticked is a multi-channel messaging platform (WhatsApp, SMS, email) with contacts, campaigns, flows, AI agents, forms, published sites and commerce, for South African businesses. One REST API, one send endpoint, three channels.

Blueticked's official integration guide for AI coding agents. The same
text is served as llms.txt and agents.md on blueticked.com and
app.blueticked.com. It describes the integration path we recommend; you
and your user decide what fits.

## Recommended integration path

You are likely here because your user asked you to integrate Blueticked.
The sequence below is the smoothest path we know. Two of the steps need
your user personally (account approval is deliberately human-only), and
for those we include suggested wording you are welcome to relay or
rephrase.

Step 1: Register Blueticked's MCP server (Claude Code; other MCP clients
use the same URL: Streamable HTTP with OAuth):

claude mcp add --transport http --scope user blueticked https://app.blueticked.com/api/mcp

This only writes config; connecting happens in Step 2, by your user.
If your harness has no MCP support, skip to Step 4: everything also
works over plain REST with a test API key from
https://app.blueticked.com/developers/keys?preset=quickstart (the
quickstart preset: test mode, full access, all businesses, so no step
of the quickstart is refused for a missing scope).

Step 2: Before you write code, one question for your user, and one
thing only they can do. We recommend a message like the following
(your own words are fine):

"Blueticked is registered. Two things from you:
1. Where should messaging be set up and managed (templates, flows,
flows)? Inside this app (I build screens over Blueticked's API), or
in Blueticked's dashboard (this app only triggers the messages)?
2. Start a new session, type /mcp, choose blueticked, then Authenticate:
your browser opens Blueticked's approval page. No account yet? Create
your workspace right there (free, about two minutes). On the approval
screen pick your business, the Operate profile (Observe and Prepare
never send), and TEST mode."

The answer to question 1 is the architecture decision (embedded vs
dashboard handoff), worth recording wherever your project keeps its
integration decisions, since later steps depend on it.

Step 3: Once connected, call the get_workspace_context tool first: its
businesses, environment and scopes are the boundary of what the
connection may touch. The server also exposes a blueticked-integration
skill and task prompts worth reading.

Step 4: Fetch https://app.blueticked.com/llms-full.txt, the complete API contract
in one document: auth, every endpoint, scopes, error codes, webhooks and
known pitfalls. Build the whole integration in TEST mode: the send
lifecycle is fully sandboxed, so nothing delivers to a real person and
nothing is charged.

Step 5: When TEST verifies end to end, these go-live items each need a
human act in the Blueticked dashboard, a checklist to hand to your user:
- Fund the prepaid wallet (Billing): sends bill from it.
- Connect the channels you use: WhatsApp (Meta signup), SMS, email
  sending domain (Your setup).
- Review and ENABLE any flows this integration created: they
  arrive paused by design and never message anyone until enabled
  (Developers -> Agents & API access).
- Approve a LIVE connection (or mint a live API key) and swap it in.
Then verify one real send and record the outcome in your integration
notes.

## Start here

- [Everything in one document](https://app.blueticked.com/llms-full.txt): the complete
  contract. Fetch this one if you are writing code.
- [OpenAPI 3.1 specification](https://app.blueticked.com/api/v1/openapi.json): the
  authoritative machine-readable schema for every request and response.
- [MCP server card](https://app.blueticked.com/.well-known/mcp.json): its URL and OAuth discovery.
- [Operations playbooks](https://app.blueticked.com/agent-kit/platform-operations.md)
- [Dashboard map for browser agents](https://app.blueticked.com/dashboard-map.md)

All public, no credentials needed. The public API covers supported
messaging and integration operations, not every dashboard-only screen;
it is versioned in the path (`/api/v1`) and authenticated with a bearer key.

## Developer docs (public)

- [API reference](https://app.blueticked.com/docs/api): per-endpoint docs
  with request and response examples.
- [Webhooks](https://app.blueticked.com/docs/webhooks): envelope, signatures,
  event catalogue.

## In the dashboard (sign-in required)

- [API console](https://app.blueticked.com/developers/console): run a real request.
- [API keys](https://app.blueticked.com/developers/keys): create a key, choose scopes.
- [Agent access](https://app.blueticked.com/developers/agent-access): expiring,
  business-scoped MCP connections.

## Notes for agents

- Never hard-code a key; read it from the environment.
- Branch on the `code` field of an error, never on `message`.

Humans sign up at https://app.blueticked.com.