Public API overview

The Keebai public API connects your CRM, your own backend, automations (Zapier, n8n, Make), or any internal tool to your WhatsApp channels and assistants. Direct, scriptable access — no portal required.

What you get

REST + JSON

Every endpoint accepts and returns JSON. Versioned under /v1/, no silent breaking changes.

Personal Access Tokens

Each user in your tenant can mint their own tokens with scoped permissions and instant revocation.

Granular scopes

Permissions split by messages, templates, channels, and webhooks. Grant only what each integration needs.

Signed webhooks

Events delivered to your URL with HMAC-SHA256, exponential retries, and event_id deduplication.

OpenAPI 3

Auto-generated spec at api.keebai.com/v1/docs-json. Importable into Postman, Insomnia, or any SDK generator.

Official CLI

keebai (npm: @keebai/cli) covers login, channel connect, token management, and messaging — all from your shell.

TypeScript SDK

@keebai/sdk — typed client with full WhatsApp coverage: text, media, interactive, templates, broadcasts.

Agent Skills

Skills for Claude Code, Cursor, Codex, and other AI agents. Your agent sends WhatsApp without you teaching it the SDK.

Base URL

https://api.keebai.com/v1

All public-API routes live under this prefix. The browsable Swagger UI is at api.keebai.com/v1/docs.

Endpoints

Session

Method	Path	Scope	Description
`GET`	`/v1/me`	—	Info about the active token and its scopes.
`DELETE`	`/v1/me/token`	—	Revoke the current token (server-side logout).

Messages

Method	Path	Scope	Description
`POST`	`/v1/messages`	`messages:send`	Send any message type on any connected channel.
`POST`	`/v1/flows`	`flows:write`	Create a WhatsApp Flow.
`POST`	`/v1/messages/bulk`	`messages:bulk`	Send a template to many recipients (up to 5,000).
`GET`	`/v1/messages/bulk/:broadcastId`	`messages:bulk`	Status of a bulk send.

Templates

Method	Path	Scope	Description
`GET`	`/v1/templates`	`templates:read`	List approved templates for your company.
`POST`	`/v1/templates`	`templates:create`	Create and submit a template to Meta for approval.
`PATCH`	`/v1/templates/:id`	`templates:update`	Update components, category, language, or status.

Channels

Method	Path	Scope	Description
`GET`	`/v1/channels`	`channels:read`	List channels, filterable by `type`.
`GET`	`/v1/channels/:id`	`channels:read`	Get a single channel.
`GET`	`/v1/whatsapp/numbers`	`channels:read`	Direct view of active `phone_number_id` values.
`POST`	`/v1/channels/whatsapp/connect`	`channels:connect`	Start a WhatsApp connection.
`GET`	`/v1/channels/whatsapp/connect/:sessionId`	`channels:connect`	Poll the connect session status.

Outbound webhooks

Method	Path	Scope	Description
`POST`	`/v1/webhooks`	`webhooks:manage`	Create a subscription. Returns the secret once.
`GET`	`/v1/webhooks`	`webhooks:read`	List subscriptions.
`GET`	`/v1/webhooks/:id`	`webhooks:read`	Get a single subscription.
`PATCH`	`/v1/webhooks/:id`	`webhooks:manage`	Update URL, events, headers, or `is_active`.
`POST`	`/v1/webhooks/:id/rotate-secret`	`webhooks:manage`	Rotate the signing secret.
`DELETE`	`/v1/webhooks/:id`	`webhooks:manage`	Delete a subscription.
`POST`	`/v1/webhooks/:id/test`	`webhooks:manage`	Fire a synthetic test event.
`GET`	`/v1/webhooks/:id/deliveries`	`webhooks:read`	Delivery history.

Full details in Webhooks → Overview.

CRM

Method	Path	Scope	Description
`GET`	`/v1/crm/customers`	`crm:customers:read`	List customers with search and phone lookup.
`GET`	`/v1/crm/customers/:id`	`crm:customers:read`	Get a single customer.
`POST`	`/v1/crm/customers`	`crm:customers:write`	Create a customer.
`PATCH`	`/v1/crm/customers/:id`	`crm:customers:write`	Partially update a customer.
`DELETE`	`/v1/crm/customers/:id`	`crm:customers:delete`	Delete a customer.
`GET`	`/v1/crm/tickets`	`crm:tickets:read`	List tickets by pipeline, stage, owner, tag, or date.
`GET`	`/v1/crm/tickets/:id`	`crm:tickets:read`	Get a single ticket.
`POST`	`/v1/crm/tickets`	`crm:tickets:write`	Open a ticket for a contact.
`PATCH`	`/v1/crm/tickets/:id`	`crm:tickets:write`	Update, close, reassign, or retag a ticket.
`POST`	`/v1/crm/tickets/:id/stage`	`crm:tickets:write`	Move a ticket to another pipeline stage.
`DELETE`	`/v1/crm/tickets/:id`	`crm:tickets:delete`	Delete a ticket.
`GET`	`/v1/crm/tasks`	`crm:tasks:read`	List tasks, filterable by status.
`GET`	`/v1/crm/tasks/:id`	`crm:tasks:read`	Get a single task.
`POST`	`/v1/crm/tasks`	`crm:tasks:write`	Create a task.
`PATCH`	`/v1/crm/tasks/:id`	`crm:tasks:write`	Update a task’s status, assignee, or due date.
`DELETE`	`/v1/crm/tasks/:id`	`crm:tasks:delete`	Delete a task.
`GET`	`/v1/crm/notes`	`crm:notes:read`	List notes by contact, ticket, or type.
`GET`	`/v1/crm/notes/:id`	`crm:notes:read`	Get a single note.
`POST`	`/v1/crm/notes`	`crm:notes:write`	Log a note, call, email, or meeting.
`PATCH`	`/v1/crm/notes/:id`	`crm:notes:write`	Edit a note’s text or type.
`DELETE`	`/v1/crm/notes/:id`	`crm:notes:delete`	Delete a note.

Full details in CRM → Overview. Note that CRM reads span the whole company while writes stay scoped to the token’s project.

Loyalty

Method	Path	Scope	Description
`GET`	`/v1/loyalty/programs`	`loyalty:read`	List programs — points, stamps, or tiers.
`GET`	`/v1/loyalty/programs/:id`	`loyalty:read`	Get a program with its rules.
`GET`	`/v1/loyalty/templates`	`loyalty:read`	List a program’s wallet card designs.
`GET`	`/v1/loyalty/templates/:id`	`loyalty:read`	Get a single template.
`GET`	`/v1/loyalty/memberships`	`loyalty:read`	Find a membership by customer, phone, or program.
`GET`	`/v1/loyalty/memberships/:id`	`loyalty:read`	Get a membership with its balance.
`POST`	`/v1/loyalty/memberships`	`loyalty:write`	Enroll a customer.
`GET`	`/v1/loyalty/memberships/:id/ledger`	`loyalty:read`	Movement history.
`POST`	`/v1/loyalty/memberships/:id/ledger`	`loyalty:write`	Accrue, redeem, or correct.
`POST`	`/v1/loyalty/memberships/:id/passes/google`	`loyalty:write`	Issue the Google Wallet pass.
`POST`	`/v1/loyalty/memberships/:id/passes/apple/link`	`loyalty:write`	Issue the Apple Wallet link.
`POST`	`/v1/loyalty/memberships/:id/passes/notify`	`loyalty:write`	Push a message to the card.
`GET`	`/v1/loyalty/memberships/:id/passes/notifications`	`loyalty:read`	Message history.

Full details in Loyalty → Overview. Programs and card designs are authored in the portal; the API covers enrollment, balances, and passes.

Next steps

Quickstart

From zero to first message in five minutes.

TypeScript SDK

Typed client for Node, edge runtimes, and browsers.

CLI

Agent Skills

Skills for Claude Code, Cursor, Codex, and other AI agents.

API keys

How to create, list, and revoke tokens.

Authentication

How to send the token on every request and handle auth errors.

Outbound webhooks

Receive signed events at your endpoint.

Connect WhatsApp

Onboard a new WhatsApp Business channel without the portal.

CRM

Customers, tickets, tasks, and notes over REST.

Ecommerce

Read the catalog, carts, and sales, and get a webhook when a sale closes.

Loyalty

Points, stamps, and tiers, with the card in Apple Wallet or Google Wallet.

Assistants

Create assistants, write the blocks that make up their prompt, and give them webhooks to call.

MCP server

Give an AI agent the same API as 101 tools, with the same token and scopes.

Is something broken?

Live availability per component, plus current and past incidents, is at status.keebai.com. It is served independently of the API, so it stays up when we do not. Check it before opening a ticket — if the component you are calling is already reported degraded, we are on it.

Roadmap

Planned, no firm dates:

Smart templates — map unstructured data into template variables with an LLM.
Scheduled messages — schedule and cancel future sends.
Tickets — open and update tickets from the API.
More webhook events — conversation.created, conversation.escalated_to_human, instagram.message.received.

Need one of these sooner? Write us at support@keebai.com.

​What you get

REST + JSON

Personal Access Tokens

Granular scopes

Signed webhooks

OpenAPI 3

Official CLI

TypeScript SDK

Agent Skills

​Base URL

​Endpoints

​Session

​Messages

​Templates

​Channels

​Outbound webhooks

​CRM

​Loyalty

​Next steps

Quickstart

TypeScript SDK

CLI

Agent Skills

API keys

Authentication

Outbound webhooks

Connect WhatsApp

CRM

Ecommerce

Loyalty

Assistants

MCP server

​Is something broken?

​Roadmap

What you get

Base URL

Endpoints

Session

Messages

Templates

Channels

Outbound webhooks

CRM

Loyalty

Next steps

Is something broken?

Roadmap