Chat SDK
Unified TypeScript SDK for building chat bots across Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp. Write bot logic once, deploy everywhere.
Start with published sources
When Chat SDK is installed in a user project, inspect the published files that ship in node_modules:
node_modules/chat/docs/ # bundled docs
node_modules/chat/dist/index.d.ts # core API types
node_modules/chat/dist/jsx-runtime.d.ts # JSX runtime types
node_modules/chat/docs/contributing/ # adapter-authoring docs
node_modules/chat/docs/guides/ # framework/platform guides
If one of the paths below does not exist, that package is not installed in the project yet.
Read these before writing code:
node_modules/chat/docs/getting-started.mdx — install and setup
node_modules/chat/docs/usage.mdx — Chat config and lifecycle
node_modules/chat/docs/handling-events.mdx — event routing and handlers
node_modules/chat/docs/threads-messages-channels.mdx — thread/channel/message model
node_modules/chat/docs/posting-messages.mdx — post, edit, delete, schedule
node_modules/chat/docs/streaming.mdx — AI SDK integration and streaming semantics
node_modules/chat/docs/cards.mdx — JSX cards
node_modules/chat/docs/actions.mdx — button/select interactions
node_modules/chat/docs/modals.mdx — modal submit/close flows
node_modules/chat/docs/slash-commands.mdx — slash command routing
node_modules/chat/docs/direct-messages.mdx — DM behavior and openDM()
node_modules/chat/docs/files.mdx — attachments/uploads
node_modules/chat/docs/state.mdx — persistence, locking, dedupe
node_modules/chat/docs/adapters.mdx — cross-platform feature matrix
node_modules/chat/docs/api/chat.mdx — exact Chat API
node_modules/chat/docs/api/thread.mdx — exact Thread API
node_modules/chat/docs/api/message.mdx — exact Message API
node_modules/chat/docs/api/modals.mdx — modal element and event details
For the specific adapter or state package you are using, inspect that installed package's dist/index.d.ts export surface in node_modules.
Quick start
import { Chat } from "chat";
import { createSlackAdapter } from "@chat-adapter/slack";
import { createRedisState } from "@chat-adapter/state-redis";
const bot = new Chat({
userName: "mybot",
adapters: {
slack: createSlackAdapter(),
},
state: createRedisState(),
dedupeTtlMs: 600_000,
});
bot.onNewMention(async (thread) => {
await thread.subscribe();
await thread.post("Hello! I'm listening to this thread.");
});
bot.onSubscribedMessage(async (thread, message) => {
await thread.post(`You said: ${message.text}`);
});
Core concepts
- Chat — main entry point; coordinates adapters, routing, locks, and state
- Adapters — platform-specific integrations for Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp
- State adapters — persistence for subscriptions, locks, dedupe, and thread state
- Thread — conversation context with
post(), stream(), subscribe(), setState(), startTyping()
- Message — normalized content with
text, formatted, attachments, author info, and platform raw
- Channel — container for threads and top-level posts
Event handlers
| Handler |
Trigger |
onNewMention |
Bot @-mentioned in an unsubscribed thread |
onDirectMessage |
New DM in an unsubscribed DM thread |
onSubscribedMessage |
Any message in a subscribed thread |
onNewMessage(regex) |
Regex match in an unsubscribed thread |
onReaction(emojis?) |
Emoji added or removed |
onAction(actionIds?) |
Button clicks and select/radio interactions |
onModalSubmit(callbackId?) |
Modal form submitted |
onModalClose(callbackId?) |
Modal dismissed/cancelled |
onSlashCommand(commands?) |
Slash command invocation |
onAssistantThreadStarted |
Slack assistant thread opened |
onAssistantContextChanged |
Slack assistant context changed |
onAppHomeOpened |
Slack App Home opened |
onMemberJoinedChannel |
Slack member joined channel event |
Read node_modules/chat/docs/handling-events.mdx, node_modules/chat/docs/actions.mdx, node_modules/chat/docs/modals.mdx, and node_modules/chat/docs/slash-commands.mdx before wiring handlers. onDirectMessage behavior is documented in node_modules/chat/docs/direct-messages.mdx.
Streaming
Pass any AsyncIterable<string> to thread.post(). For AI SDK, prefer result.fullStream over result.textStream when available so step boundaries are preserved.
import { ToolLoopAgent } from "ai";
const agent = new ToolLoopAgent({ model: "anthropic/claude-4.5-sonnet" });
bot.onNewMention(async (thread, message) => {
const result = await agent.stream({ prompt: message.text });
await thread.post(result.fullStream);
});
Key details:
streamingUpdateIntervalMs controls post+edit fallback cadence
fallbackStreamingPlaceholderText defaults to "..."; set null to disable
- Structured
StreamChunk support is Slack-only; other adapters ignore non-text chunks
Cards and modals (JSX)
Set jsxImportSource: "chat" in tsconfig.json.
Card components:
Card, CardText, Section, Fields, Field, Button, CardLink, LinkButton, Actions, Select, SelectOption, RadioSelect, Table, Image, Divider
Modal components:
Modal, TextInput, Select, SelectOption, RadioSelect
await thread.post(
<Card title="Order #1234">
<CardText>Your order has been received.</CardText>
<Actions>
<Button id="approve" style="primary">Approve</Button>
<Button id="reject" style="danger">Reject</Button>
</Actions>
</Card>
);
Adapter inventory
Official platform adapters
| Platform |
Package |
Factory |
| Slack |
@chat-adapter/slack |
createSlackAdapter |
| Microsoft Teams |
@chat-adapter/teams |
createTeamsAdapter |
| Google Chat |
@chat-adapter/gchat |
createGoogleChatAdapter |
| Discord |
@chat-adapter/discord |
createDiscordAdapter |
| GitHub |
@chat-adapter/github |
createGitHubAdapter |
| Linear |
@chat-adapter/linear |
createLinearAdapter |
| Telegram |
@chat-adapter/telegram |
createTelegramAdapter |
| WhatsApp Business Cloud |
@chat-adapter/whatsapp |
createWhatsAppAdapter |
Official state adapters
| State backend |
Package |
Factory |
| Redis |
@chat-adapter/state-redis |
createRedisState |
| ioredis |
@chat-adapter/state-ioredis |
createIoRedisState |
| PostgreSQL |
@chat-adapter/state-pg |
createPostgresState |
| Memory |
@chat-adapter/state-memory |
createMemoryState |
Community adapters
chat-state-cloudflare-do
@beeper/chat-adapter-matrix
chat-adapter-imessage
@bitbasti/chat-adapter-webex
@resend/chat-sdk-adapter
@zernio/chat-sdk-adapter
chat-adapter-baileys
@liveblocks/chat-sdk-adapter
chat-adapter-sendblue
chat-adapter-zalo
chat-adapter-mattermost
Coming-soon platform entries
- Instagram
- Signal
- X
- Messenger
Building a custom adapter
Read these published docs first:
node_modules/chat/docs/contributing/building.mdx
node_modules/chat/docs/contributing/testing.mdx
node_modules/chat/docs/contributing/publishing.mdx
Also inspect:
node_modules/chat/dist/index.d.ts — Adapter and related interfaces
node_modules/@chat-adapter/shared/dist/index.d.ts — shared errors and utilities
- Installed official adapter
dist/index.d.ts files — reference implementations for config and APIs
A custom adapter needs request verification, webhook parsing, message/thread/channel operations, ID encoding/decoding, and a format converter. Use BaseFormatConverter from chat and shared utilities from @chat-adapter/shared.
Webhook setup
Each registered adapter exposes bot.webhooks.<name>. Wire those directly to your HTTP framework routes. See node_modules/chat/docs/guides/slack-nextjs.mdx and node_modules/chat/docs/guides/discord-nuxt.mdx for framework-specific route patterns.
1---2name: chat-sdk-23description: Build multi-platform chat bots with Chat SDK (`chat` npm package). Use when developers want to build a Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, or WhatsApp bot, handle mentions, direct messages, subscribed threads, reactions, slash commands, cards, modals, files, or AI streaming, set up webhook routes or multi-adapter bots, send rich cards or streamed AI responses to chat platforms, or build a custom adapter or state adapter.4metadata:5 source: https://skillmd.com/skills/mattpocock/chat-sdk-26---78# Chat SDK910Unified TypeScript SDK for building chat bots across Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp. Write bot logic once, deploy everywhere.1112## Start with published sources1314When Chat SDK is installed in a user project, inspect the published files that ship in `node_modules`:1516```17node_modules/chat/docs/ # bundled docs18node_modules/chat/dist/index.d.ts # core API types19node_modules/chat/dist/jsx-runtime.d.ts # JSX runtime types20node_modules/chat/docs/contributing/ # adapter-authoring docs21node_modules/chat/docs/guides/ # framework/platform guides22```2324If one of the paths below does not exist, that package is not installed in the project yet.2526Read these before writing code:27- `node_modules/chat/docs/getting-started.mdx` — install and setup28- `node_modules/chat/docs/usage.mdx` — `Chat` config and lifecycle29- `node_modules/chat/docs/handling-events.mdx` — event routing and handlers30- `node_modules/chat/docs/threads-messages-channels.mdx` — thread/channel/message model31- `node_modules/chat/docs/posting-messages.mdx` — post, edit, delete, schedule32- `node_modules/chat/docs/streaming.mdx` — AI SDK integration and streaming semantics33- `node_modules/chat/docs/cards.mdx` — JSX cards34- `node_modules/chat/docs/actions.mdx` — button/select interactions35- `node_modules/chat/docs/modals.mdx` — modal submit/close flows36- `node_modules/chat/docs/slash-commands.mdx` — slash command routing37- `node_modules/chat/docs/direct-messages.mdx` — DM behavior and `openDM()`38- `node_modules/chat/docs/files.mdx` — attachments/uploads39- `node_modules/chat/docs/state.mdx` — persistence, locking, dedupe40- `node_modules/chat/docs/adapters.mdx` — cross-platform feature matrix41- `node_modules/chat/docs/api/chat.mdx` — exact `Chat` API42- `node_modules/chat/docs/api/thread.mdx` — exact `Thread` API43- `node_modules/chat/docs/api/message.mdx` — exact `Message` API44- `node_modules/chat/docs/api/modals.mdx` — modal element and event details4546For the specific adapter or state package you are using, inspect that installed package's `dist/index.d.ts` export surface in `node_modules`.4748## Quick start4950```typescript51import { Chat } from "chat";52import { createSlackAdapter } from "@chat-adapter/slack";53import { createRedisState } from "@chat-adapter/state-redis";5455const bot = new Chat({56 userName: "mybot",57 adapters: {58 slack: createSlackAdapter(),59 },60 state: createRedisState(),61 dedupeTtlMs: 600_000,62});6364bot.onNewMention(async (thread) => {65 await thread.subscribe();66 await thread.post("Hello! I'm listening to this thread.");67});6869bot.onSubscribedMessage(async (thread, message) => {70 await thread.post(`You said: ${message.text}`);71});72```7374## Core concepts7576- **Chat** — main entry point; coordinates adapters, routing, locks, and state77- **Adapters** — platform-specific integrations for Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp78- **State adapters** — persistence for subscriptions, locks, dedupe, and thread state79- **Thread** — conversation context with `post()`, `stream()`, `subscribe()`, `setState()`, `startTyping()`80- **Message** — normalized content with `text`, `formatted`, attachments, author info, and platform `raw`81- **Channel** — container for threads and top-level posts8283## Event handlers8485| Handler | Trigger |86|---------|---------|87| `onNewMention` | Bot @-mentioned in an unsubscribed thread |88| `onDirectMessage` | New DM in an unsubscribed DM thread |89| `onSubscribedMessage` | Any message in a subscribed thread |90| `onNewMessage(regex)` | Regex match in an unsubscribed thread |91| `onReaction(emojis?)` | Emoji added or removed |92| `onAction(actionIds?)` | Button clicks and select/radio interactions |93| `onModalSubmit(callbackId?)` | Modal form submitted |94| `onModalClose(callbackId?)` | Modal dismissed/cancelled |95| `onSlashCommand(commands?)` | Slash command invocation |96| `onAssistantThreadStarted` | Slack assistant thread opened |97| `onAssistantContextChanged` | Slack assistant context changed |98| `onAppHomeOpened` | Slack App Home opened |99| `onMemberJoinedChannel` | Slack member joined channel event |100101Read `node_modules/chat/docs/handling-events.mdx`, `node_modules/chat/docs/actions.mdx`, `node_modules/chat/docs/modals.mdx`, and `node_modules/chat/docs/slash-commands.mdx` before wiring handlers. `onDirectMessage` behavior is documented in `node_modules/chat/docs/direct-messages.mdx`.102103## Streaming104105Pass any `AsyncIterable<string>` to `thread.post()`. For AI SDK, prefer `result.fullStream` over `result.textStream` when available so step boundaries are preserved.106107```typescript108import { ToolLoopAgent } from "ai";109110const agent = new ToolLoopAgent({ model: "anthropic/claude-4.5-sonnet" });111112bot.onNewMention(async (thread, message) => {113 const result = await agent.stream({ prompt: message.text });114 await thread.post(result.fullStream);115});116```117118Key details:119- `streamingUpdateIntervalMs` controls post+edit fallback cadence120- `fallbackStreamingPlaceholderText` defaults to `"..."`; set `null` to disable121- Structured `StreamChunk` support is Slack-only; other adapters ignore non-text chunks122123## Cards and modals (JSX)124125Set `jsxImportSource: "chat"` in `tsconfig.json`.126127Card components:128- `Card`, `CardText`, `Section`, `Fields`, `Field`, `Button`, `CardLink`, `LinkButton`, `Actions`, `Select`, `SelectOption`, `RadioSelect`, `Table`, `Image`, `Divider`129130Modal components:131- `Modal`, `TextInput`, `Select`, `SelectOption`, `RadioSelect`132133```tsx134await thread.post(135 <Card title="Order #1234">136 <CardText>Your order has been received.</CardText>137 <Actions>138 <Button id="approve" style="primary">Approve</Button>139 <Button id="reject" style="danger">Reject</Button>140 </Actions>141 </Card>142);143```144145## Adapter inventory146147### Official platform adapters148149| Platform | Package | Factory |150|---------|---------|---------|151| Slack | `@chat-adapter/slack` | `createSlackAdapter` |152| Microsoft Teams | `@chat-adapter/teams` | `createTeamsAdapter` |153| Google Chat | `@chat-adapter/gchat` | `createGoogleChatAdapter` |154| Discord | `@chat-adapter/discord` | `createDiscordAdapter` |155| GitHub | `@chat-adapter/github` | `createGitHubAdapter` |156| Linear | `@chat-adapter/linear` | `createLinearAdapter` |157| Telegram | `@chat-adapter/telegram` | `createTelegramAdapter` |158| WhatsApp Business Cloud | `@chat-adapter/whatsapp` | `createWhatsAppAdapter` |159160### Official state adapters161162| State backend | Package | Factory |163|--------------|---------|---------|164| Redis | `@chat-adapter/state-redis` | `createRedisState` |165| ioredis | `@chat-adapter/state-ioredis` | `createIoRedisState` |166| PostgreSQL | `@chat-adapter/state-pg` | `createPostgresState` |167| Memory | `@chat-adapter/state-memory` | `createMemoryState` |168169### Community adapters170171- `chat-state-cloudflare-do`172- `@beeper/chat-adapter-matrix`173- `chat-adapter-imessage`174- `@bitbasti/chat-adapter-webex`175- `@resend/chat-sdk-adapter`176- `@zernio/chat-sdk-adapter`177- `chat-adapter-baileys`178- `@liveblocks/chat-sdk-adapter`179- `chat-adapter-sendblue`180- `chat-adapter-zalo`181- `chat-adapter-mattermost`182183### Coming-soon platform entries184185- Instagram186- Signal187- X188- Messenger189190## Building a custom adapter191192Read these published docs first:193- `node_modules/chat/docs/contributing/building.mdx`194- `node_modules/chat/docs/contributing/testing.mdx`195- `node_modules/chat/docs/contributing/publishing.mdx`196197Also inspect:198- `node_modules/chat/dist/index.d.ts` — `Adapter` and related interfaces199- `node_modules/@chat-adapter/shared/dist/index.d.ts` — shared errors and utilities200- Installed official adapter `dist/index.d.ts` files — reference implementations for config and APIs201202A custom adapter needs request verification, webhook parsing, message/thread/channel operations, ID encoding/decoding, and a format converter. Use `BaseFormatConverter` from `chat` and shared utilities from `@chat-adapter/shared`.203204## Webhook setup205206Each registered adapter exposes `bot.webhooks.<name>`. Wire those directly to your HTTP framework routes. See `node_modules/chat/docs/guides/slack-nextjs.mdx` and `node_modules/chat/docs/guides/discord-nuxt.mdx` for framework-specific route patterns.