IntroductionGetting Started

Usage

Creating a Chat InstanceThreads, Messages, and ChannelsHandling EventsPosting Messages

Adapters

Platform AdaptersState Adapters

Features

Overlapping MessagesActionsCardsDirect messagesEmojiEphemeral messagesFile uploadsModalsSlash CommandsStreamingError handling

Guides

Slack bot with Next.js and RedisDurable chat sessions with Next.js, Workflow, and RedisSchedule Slack posts with Next.js, Workflow, and NeonCode review GitHub bot with Hono and RedisDiscord support bot with Nuxt and Redis

API Reference

OverviewChatThreadChannelMessagePostableMessageCardsMarkdownModals

Contributing

Building a community adapterTesting adaptersDocumenting your adapterPublishing your adapter

Adapters

Browse official and community-built adapters to connect your bot to any platform.

Browse by messenger

iMessageWhatsAppTelegramSlackDiscordTeamsMatrixInstagramFacebookX/TwitterGitHubLinearEmailWebexGoogle ChatZaloMattermost

Official

Published under @chat-adapter/* and maintained by Vercel.

Slack
Beta
Build bots for Slack workspaces with full support for threads, reactions, and interactive messages.
@chat-adapter/slack
Microsoft Teams
Beta
Deploy bots to Microsoft Teams with adaptive cards, mentions, and conversation threading.
@chat-adapter/teams
Google Chat
Beta
Integrate with Google Chat spaces for team collaboration and automated workflows.
@chat-adapter/gchat
Discord
Beta
Create Discord bots with slash commands, threads, and rich embeds.
@chat-adapter/discord
GitHub
Beta
Build bots that respond to pull request and issue comment threads.
@chat-adapter/github
Linear
Beta
Automate Linear issue comment threads with bot responses and workflows.
@chat-adapter/linear
Telegram
Beta
Connect to Telegram with support for groups, channels, and inline keyboards.
@chat-adapter/telegram
WhatsApp Business Cloud
Beta
Connect to WhatsApp Business Cloud for customer messaging and automated conversations.
@chat-adapter/whatsapp

Vendor Official

Built and maintained by the platform vendor.

Beeper Matrix
Vendor official
Matrix adapter for Chat SDK, built and maintained by Beeper.
@beeper/chat-adapter-matrix
Photon iMessage
Vendor official
iMessage adapter for Chat SDK. Supports both local (on-device) and Photon iMessage integration.
chat-adapter-imessage
Resend
Vendor official
Bidirectional email adapter for Chat SDK with threading, rich HTML emails, and attachment support via Resend.
@resend/chat-sdk-adapter
Zernio
Vendor official
Unified social media DM adapter covering Instagram, Facebook, Telegram, WhatsApp, X/Twitter, Bluesky, and Reddit through a single integration.
@zernio/chat-sdk-adapter
Liveblocks
Vendor official
Liveblocks Comments adapter for building conversational bots on top of Liveblocks rooms, threads, and comments.
@liveblocks/chat-sdk-adapter
Build your own adapter

Community

Built by third-party developers.

Webex
Community Webex adapter for Chat SDK with support for spaces, threads, and adaptive cards.
@bitbasti/chat-adapter-webex
Baileys WhatsApp
Chat SDK adapter for Baileys (Unofficial WhatsApp API).
chat-adapter-baileys
Sendblue iMessage
iMessage adapter for Chat SDK using Sendblue for building your own iMessage bots.
chat-adapter-sendblue
Zalo
Zalo adapter for Chat SDK using Zalo for building your own Zalo bots.
chat-adapter-zalo
Mattermost
Mattermost adapter for Chat SDK with support for posts, reactions, and slash commands.
chat-adapter-mattermost
Build your own adapter

State Adapters

Pluggable state adapters for thread subscriptions, distributed locking, and caching.

Official

Published under @chat-adapter/* and maintained by Vercel.

Redis
Beta
Production-ready state adapter using Redis for persistence and distributed locking.
@chat-adapter/state-redis
ioredis
Beta
Redis state adapter using ioredis with cluster and sentinel support.
@chat-adapter/state-ioredis
PostgreSQL
Beta
Production state adapter using PostgreSQL for persistence and distributed locking.
@chat-adapter/state-pg
Memory
Beta
In-memory state adapter for development and testing environments.
@chat-adapter/state-memory

Community

Built by third-party developers.

Cloudflare Durable Objects
Cloudflare Durable Objects state adapter with SQLite-backed persistence, distributed locking, and caching.
chat-state-cloudflare-do
Build your own adapter