TypeScript SDK
The official typed client for the Kerabie API.
Install
npm install @kerabie/sdk
Package
@kerabie/sdk
Language
TypeScript
Platforms
Node.js and server-side JavaScript
What it is
The Kerabie TypeScript SDK (@kerabie/sdk on npm) lets you work with conversations, customers, visitors, agents, the knowledge base and analytics from your own backend, scripts or internal tools, with full type definitions and webhook signature verification.
API access is included on every plan, including Free.
Typed resources
conversations, customers, visitors, agents, kb and analytics, each with typed parameters and responses.
Webhook helpers
Static verify and parse methods check the signature and give you a typed event.
One error type
Every failure throws KerAbieError with the HTTP status and a readable message.
Works with the MCP server
The Kerabie MCP server reads this SDK’s type declarations, so your coding assistant writes correct calls.
Code
import { KerAbieClient } from '@kerabie/sdk';
const kerabie = new KerAbieClient({
apiKey: process.env.KERABIE_API_KEY!,
orgId: 42,
});
const { conversations } = await kerabie.conversations.list({ status: 'open', limit: 20 });
await kerabie.conversations.sendMessage(conversations[0].id, {
body: 'Your order has shipped.',
senderType: 'bot',
});const valid = KerAbieClient.webhooks.verify(
req.body, // raw Buffer
req.headers['x-kerabie-signature'],
process.env.KERABIE_WEBHOOK_SECRET!,
);
if (valid) {
const event = KerAbieClient.webhooks.parse(req.body);
// event.event === 'conversation.created'
}Requirements
- Node.js 18 or later
- A Kerabie API key (Settings, Integrations, API Keys)
- An API key, available on every plan including Free
Questions
Does Kerabie have a TypeScript SDK?
Yes. It is published on npm as @kerabie/sdk and maintained by Kerabie. Install it with npm install @kerabie/sdk.
Can I use it in the browser?
It is designed for servers and scripts, where your API key stays secret. For websites, use the Kerabie web widget instead.
How do I verify webhooks?
Use KerAbieClient.webhooks.verify with the raw request body, the X-Kerabie-Signature header and your webhook secret.
More from Kerabie for developers
Ship with Kerabie today
Create a free workspace, grab your key and install in minutes.