BluetickedDeveloper docs

MCP server

Connect Blueticked to Claude Code, Codex or any MCP client and call the API as tools.

Connect it

A remote server — there is nothing to install, and the tool list can never be a version behind the API.

Claude Code
claude mcp add --transport http --scope user blueticked https://app.blueticked.com/api/mcp
Codex
codex mcp add blueticked --url https://app.blueticked.com/api/mcp
codex mcp login blueticked

Claude Desktop and claude.ai (paid plans): open Settings → Connectors → Add custom connector and paste https://app.blueticked.com/api/mcp. Claude opens the Blueticked sign-in and the same approval screen as every other client.

Registering only writes config. Then authenticate (in Claude Code: /mcp, choose blueticked, Authenticate): the browser opens Blueticked’s approval page, where you choose the organization, which businesses the agent may touch, an access profile, Test or Live, and an expiry. Approve a Test connection while you build. Your client stores and refreshes its OAuth tokens; no API key is copied into the project.

A client that cannot sign in (a script or a CI job) uses an expiring key from Agent access instead, sent as the Authorization header. The shell expands the variable when you run the command, so Claude Code stores the key in its MCP config. A full API key (blu_ prefix) from API keys works the same way.

Without OAuth
claude mcp add --transport http --scope user blueticked https://app.blueticked.com/api/mcp --header "Authorization: Bearer $BLUETICKED_AGENT_KEY"

Knowledge built into the connection

8 resources and 9 guided prompts give an agent the current contract and a safe implementation workflow without repository access.

Complete API resource
blueticked://docs/full contains authentication, scopes, endpoints, examples, errors, and webhook rules in one read.
Machine-readable contract
blueticked://openapi exposes the same generated OpenAPI 3.1 document used by the Developer Hub and SDK workflow.
Drop-in project instructions
AGENTS.md, CLAUDE.md, SKILL.md, and production integration recipes are available as MCP resources and public downloads.
Guided implementation prompts
Built-in prompts cover SMS OTP, WhatsApp notifications, transactional email, signed webhooks, and production-readiness audits.

What your agent can do

51 tools: typed ones for the work integrations actually do, one for each area of the API that names every operation it has, plus a discovery tool and an escape hatch that reaches anything else. Creating a business and minting its keys stay with an owner in the Blueticked dashboard: an agent connection is never given that permission (businesses:write), so it cannot do either.

  • get_workspace_contextRead the credential's organization, accessible businesses, environment, scopes and rate limit.
  • list_campaignsList campaign runs and delivery counters.
  • get_campaignRead one campaign's status and sent, delivered and failed counters.
  • launch_campaignValidate, schedule or launch a bulk WhatsApp, SMS or email campaign.
  • list_conversationsList inbox conversations, newest first.
  • get_conversationRead one inbox conversation's channel, contact, status, assignment and unread count.
  • list_conversation_messagesRead one inbox conversation's message history in chronological order.
  • update_conversationMove an inbox conversation between open, pending and resolved, or assign it to a user.
  • list_flowsList WhatsApp Forms, including draft and published status, for accessible businesses.
  • get_flowRead one WhatsApp Form and its complete Blueticked builder definition.
  • create_flowCreate a draft WhatsApp Form for one business.
  • update_flowUpdate a draft WhatsApp Form's name, description or builder definition.
  • publish_flowPublish a validated WhatsApp Form to Meta.
  • send_messageSend one WhatsApp, SMS or email message.
  • get_messageFetch the current status and provider identifiers of a previously queued message.
  • list_contactsList contacts, cursor-paginated.
  • create_contactCreate a contact, or update the existing one matched by phone or email.
  • list_templatesList WhatsApp templates with their Meta approval status.
  • list_channelsInventory of connected channels (WhatsApp, SMS, email) and their connection status.
  • list_webhooksList webhook subscriptions.
  • create_webhookSubscribe an https endpoint to events.
  • test_webhookSend a signed sample event to an active webhook subscription.
  • list_webhook_deliveriesInspect webhook delivery attempts, receiver responses, retry counts and final outcomes.
  • replay_webhook_deliveryReplay a previous webhook delivery after its receiver is fixed.
  • trigger_eventFire a saved Blueticked flow from an external system (booking tool, CRM, website form).
  • get_walletRead the prepaid wallet balance.
  • list_endpointsDiscover the full REST API: every endpoint with its method, path, required scope and summary. Use this when the task needs something the typed tools above do not cover, then call it with call_api. Pass `filter` (a path fragment or keyword) and each match also returns its required fields and a complete working example body — call it filtered before writing any request, rather than guessing the payload.
  • call_apiCall any Blueticked v1 endpoint directly. The escape hatch for anything the typed tools do not cover. Call `list_endpoints` WITH A FILTER first — it returns the required fields and a working example body for each match, so you do not have to guess the request shape. Authenticated with the same key and subject to the same scopes and rate limits.
  • readinessEverything the Blueticked API does for readiness.
  • businessesEverything the Blueticked API does for businesses.
  • contactsEverything the Blueticked API does for contacts.
  • groupsEverything the Blueticked API does for groups.
  • segmentsEverything the Blueticked API does for segments.
  • conversationsEverything the Blueticked API does for conversations.
  • ticketsEverything the Blueticked API does for tickets.
  • tablesEverything the Blueticked API does for tables.
  • templatesEverything the Blueticked API does for templates.
  • flowsEverything the Blueticked API does for flows.
  • studio_flowsEverything the Blueticked API does for studio flows.
  • journeysEverything the Blueticked API does for journeys.
  • ai_agentsEverything the Blueticked API does for ai agents.
  • sitesEverything the Blueticked API does for sites.
  • form_submissionsEverything the Blueticked API does for form submissions.
  • channelsEverything the Blueticked API does for channels.
  • webhooksEverything the Blueticked API does for webhooks.
  • integrationsEverything the Blueticked API does for integrations.
  • suppressionEverything the Blueticked API does for suppression.
  • emailEverything the Blueticked API does for email.
  • walletEverything the Blueticked API does for wallet.
  • conversionsEverything the Blueticked API does for conversions.
  • commerceEverything the Blueticked API does for commerce.

Access profiles

What a connection may do is fixed by the profile chosen on the approval screen.

Observe
every read scope (21), nothing that changes or sends.
Prepare
Observe plus contacts:write, campaigns:write, conversations:write, suppression:write, commerce:write, conversions:write, automations:write, sites:write, forms:write. Observe and Prepare never send, publish or call an outside system.
Operate
every scope, including sends, publishing, webhooks:write and channels, except businesses:write, which no agent connection is ever given.

What it can and cannot reach

Delegated, never wider
Blueticked exchanges the OAuth token for the encrypted Agent key your approval created, and that key is the whole of its authority: the same API scopes, business restrictions, Test or Live environment and rate limits, never wider than the approved grant. The token works on the REST API as well as /api/mcp, so a connected app can call /api/v1 directly on the same consented, revocable grant instead of a pasted key.
No second permission model
Observe, Prepare and Operate profiles resolve to fixed API scopes on the server. The delegated key is encrypted at rest and never returned to the client. If its API request would return 403, the MCP tool does too. Every tool also advertises its route and required scope in _meta, so an agent can tell what it may call before calling it.
Failures come back readable
An API error is returned as the tool's result, not swallowed into a protocol error, so the agent can read the code and correct itself.
Reachable only inside /api/v1
The escape-hatch tool takes a path, and anything outside the public API — absolute URLs, traversal, internal routes — is refused before a request is made.

Build against the sandbox first

Approve a Test connection and the agent can exercise the whole integration — sends, webhooks, failures and inbound replies — without touching a provider or spending anything.

Test connections simulate every provider, bill nothing, and support rehearsing failures on purpose with the X-Simulate-Error header. See test mode and magic numbers.

Plain-text context for agents

If you would rather hand your agent the whole contract than connect a server, these are public and need no credentials.

llms.txt
The index: what Blueticked is, where everything lives. https://app.blueticked.com/llms.txt
llms-full.txt
The complete contract in one document: auth, conventions, every endpoint, scopes, error codes, webhooks and the known pitfalls. This is the one to fetch if you are writing code. https://app.blueticked.com/llms-full.txt
openapi.json
OpenAPI 3.1, the authoritative machine-readable schema. https://app.blueticked.com/api/v1/openapi.json
agents.md
The same agent instruction as llms.txt, under the name some agents look for first. https://app.blueticked.com/agents.md
dashboard-map.md
A dashboard map, for agents driving the UI rather than the API. https://app.blueticked.com/dashboard-map.md