Getting Started
Start with the usage guides to learn how a bot handles incoming events and posts messages, then add the adapters for your chat platforms and state backend.
Usage
Learn the core patterns for handling incoming events and posting messages back to your users.
Creating a Chat Instance
Initialize the Chat class with adapters, state, and configuration options.
Threads, Messages, and Channels
Work with threads, messages, and channels across platforms.
Handling Events
Register handlers for mentions, messages, reactions, and platform-specific events.
Posting Messages
Send plain text, markdown, cards, and streams with thread.post().
Adapters
Connect your bot to chat platforms and persist state across restarts.
Platform Adapters
Connect your bot to messaging platforms with webhook verification, parsing, and native formatting.
State Adapters
Pluggable state adapters for thread subscriptions, distributed locking, and caching.
Browse all official, vendor-official, and community adapters on the Adapters page.
Resources
- The Complete Guide to Chat SDK: an end-to-end walkthrough that takes you from an empty project to a deployed multi-platform bot, covering adapters, state, handlers, cards, and streaming.
See all guides and templates on the resources page.
Read more
Creating a Chat Instance
Initialize the Chat class with adapters, state, and configuration options.
Platform Adapters
Platform adapters connect your bot to messaging platforms such as Slack, Teams, and Google Chat.
Vercel Connect
Authenticate Slack, Microsoft Teams, GitHub, Linear, Discord, Notion, and Telegram adapters with Vercel Connect, using short-lived runtime tokens for outbound calls and OIDC-verified inbound webhooks where supported.
CLI
Scaffold a Chat SDK bot app with a single command.